GNU bug report logs - #54550
Debugging elisp files

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 54550 in the body.
You can then email your comments to 54550 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: goncholden <goncholden <at> protonmail.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: Debugging elisp files
Date: Thu, 24 Mar 2022 18:19:13 +0000

[Message part 1 (text/plain, inline)]

I am debugging a large file because of the following error,

Warning (initialization): An error occurred while loading ‘/home/goncho/.emacs’:
Invalid read syntax: )

This means that I have a trailing parenthesis. To ensure normal operation, I have to investigate and remove the cause of the error in my initialization file. But I am finding
the task problematic, because using the `--debug-init` option to view a complete error backtrace, has not properly located the problem. It is unfortunate that with just one mark makes the file impossible to parse from start to end. Can emacs be made to handle these things better rather than reject all the file?

The best way to find the problem is to use a binary space partitioning scheme. This means to divide the file in half (comment out one part) or put half in another file. Then check if the error occurs in the code that has not been commented out or resides in the other file. If it does, one has to divide again that part in half and repeat the process until one narrows down to the source of the problem. The process is very tedious.

In texinfo, there exists the "@ignore" and "@end ignore" tags that comment out sections of texinfo code. This makes it much easier to debug texinfo files, because one does not have to constantly comment every line, and with the advantage that one can leave the file almost intact.

I would be grateful if emacs could improve on the user debugging part, so debugging can be made more convenient for users in order to reduce downtime. Am not sure if the manual can describe the procedures to debug in a quicker and easier manner, both for new users of elisp programming and experienced ones who would benefit from fixing problem quite rapidly.

[Message part 2 (text/html, inline)]

Message #8 received at 54550 <at> debbugs.gnu.org (full text, mbox):

From: Robert Pluim <rpluim <at> gmail.com>
To: goncholden <goncholden <at> protonmail.com>
Cc: 54550 <at> debbugs.gnu.org
Subject: Re: bug#54550: Debugging elisp files
Date: Fri, 25 Mar 2022 09:30:34 +0100

>>>>> On Thu, 24 Mar 2022 18:19:13 +0000, goncholden via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org> said:

    >> I am debugging a large file because of the following error,
    >> Warning (initialization): An error occurred while loading ‘/home/goncho/.emacs’:
    >> Invalid read syntax: )

One way to work with this is to put point at the beginning of .emacs
and eval

(while t (forward-sexp))

That will error and tell you at what character position itʼs failing.

    >> In texinfo, there exists the "@ignore" and "@end ignore" tags that
    >> comment out sections of texinfo code. This makes it much easier to
    >> debug texinfo files, because one does not have to constantly comment
    >> every line, and with the advantage that one can leave the file almost
    >> intact.

You can wrap blocks of code in (when nil) to achieve the same.

Robert
-- 

Message #11 received at 54550 <at> debbugs.gnu.org (full text, mbox):

From: goncholden <goncholden <at> protonmail.com>
To: Robert Pluim <rpluim <at> gmail.com>
Cc: 54550 <at> debbugs.gnu.org
Subject: Re: bug#54550: Debugging elisp files
Date: Fri, 25 Mar 2022 08:38:31 +0000

Sent with ProtonMail secure email.

------- Original Message -------

On Friday, March 25th, 2022 at 8:30 PM, Robert Pluim <rpluim <at> gmail.com> wrote:

> > > > > > On Thu, 24 Mar 2022 18:19:13 +0000, goncholden via "Bug reports for GNU Emacs, the Swiss army knife of text editors" bug-gnu-emacs <at> gnu.org said:
>
> >> I am debugging a large file because of the following error,
>
> >> Warning (initialization): An error occurred while loading ‘/home/goncho/.emacs’:
> >> Invalid read syntax: )
>
> One way to work with this is to put point at the beginning of .emacs
> and eval
>
> (while t (forward-sexp))
>
> That will error and tell you at what character position itʼs failing.

> >> In texinfo, there exists the "@ignore" and "@end ignore" tags that
> >> comment out sections of texinfo code. This makes it much easier to
> >> debug texinfo files, because one does not have to constantly comment
> >> every line, and with the advantage that one can leave the file almost
> >> intact.

> You can wrap blocks of code in (when nil) to achieve the same.
> Robert

I cannot say that the "(when nil)" can include a chunk of defuns though,
only sections within a function.

Message #14 received at 54550 <at> debbugs.gnu.org (full text, mbox):

From: Robert Pluim <rpluim <at> gmail.com>
To: goncholden <goncholden <at> protonmail.com>
Cc: 54550 <at> debbugs.gnu.org
Subject: Re: bug#54550: Debugging elisp files
Date: Fri, 25 Mar 2022 09:51:25 +0100

>>>>> On Fri, 25 Mar 2022 08:38:31 +0000, goncholden <goncholden <at> protonmail.com> said:
    >> You can wrap blocks of code in (when nil) to achieve the same.
    >> Robert

    goncholden> I cannot say that the "(when nil)" can include a chunk of defuns though,
    goncholden> only sections within a function.

Have you tried it? `defun' forms are no different from any other lisp
form in that respect.

Robert
-- 

Message #17 received at 54550 <at> debbugs.gnu.org (full text, mbox):

From: goncholden <goncholden <at> protonmail.com>
To: Robert Pluim <rpluim <at> gmail.com>
Cc: 54550 <at> debbugs.gnu.org
Subject: Re: bug#54550: Debugging elisp files
Date: Fri, 25 Mar 2022 11:47:32 +0000

------- Original Message -------

On Friday, March 25th, 2022 at 8:51 PM, Robert Pluim <rpluim <at> gmail.com> wrote:

> > > > > > On Fri, 25 Mar 2022 08:38:31 +0000, goncholden goncholden <at> protonmail.com said:
>
> >> You can wrap blocks of code in (when nil) to achieve the same.
>
> >> Robert
>
> goncholden> I cannot say that the "(when nil)" can include a chunk of defuns though,
>
> goncholden> only sections within a function.
>
> Have you tried it? `defun' forms are no different from any other lisp
> form in that respect.
>
> Robert

That sounds good.

Message #20 received at 54550 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: goncholden <goncholden <at> protonmail.com>
Cc: 54550 <at> debbugs.gnu.org
Subject: Re: bug#54550: Debugging elisp files
Date: Fri, 25 Mar 2022 17:22:00 +0100

goncholden <goncholden <at> protonmail.com> writes:

> The best way to find the problem is to use a binary space partitioning
> scheme.

As Robert has already noted, the easiest way to find these errors is to
just go to the start of the file and hold the `C-M-f' key combination
down until Emacs beeps.

However, the error message here is supposed to say what line the error
is on, and it didn't, so I've now fixed that in Emacs 29.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.