GNU bug report logs - #15038
24.3.50; Doc bug in "(eintr) Change a defun"

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 15038 in the body.
You can then email your comments to 15038 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: dmoncayo <at> gmail.com
To: bug-gnu-emacs <at> gnu.org
Subject: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Tue, 06 Aug 2013 23:38:07 +0200

The following paragraph is in the info node mentioned in the subject:

     *Note Beginning a `.emacs' File.emacs File, and *note
  Comments(elisp) for more about comments.

There seems to be a problem in its first cross reference, because:
* The link is broken.
* The part ".emacs File" just after the link doesn't make sense.

(I guess that the problem is due to the use of "@file" inside "@xref")

In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-08-05 on LEG570
Bzr revision: 113709 monnier <at> iro.umontreal.ca-20130805180546-vbxtmpcn25l6w4fr
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/usr --enable-checking CFLAGS='-O0 -g3'
 CPPFLAGS='-DGLYPH_DEBUG=1 -I/c/usr/include''

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

From: Glenn Morris <rgm <at> gnu.org>
To: dmoncayo <at> gmail.com
Cc: 15038 <at> debbugs.gnu.org
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Tue, 06 Aug 2013 19:23:17 -0400

dmoncayo <at> gmail.com wrote:

> The following paragraph is in the info node mentioned in the subject:
>
>      *Note Beginning a `.emacs' File.emacs File, and *note
>   Comments(elisp) for more about comments.
>
> There seems to be a problem in its first cross reference, because:
> * The link is broken.
> * The part ".emacs File" just after the link doesn't make sense.

I see no such problem on GNU/Linux with makeinfo 4.13 or 5.1.
What makeinfo did you use?

> In GNU Emacs 24.3.50.1 (i686-pc-mingw32)

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org, dmoncayo <at> gmail.com
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 06:56:43 +0300

> From: Glenn Morris <rgm <at> gnu.org>
> Date: Tue, 06 Aug 2013 19:23:17 -0400
> Cc: 15038 <at> debbugs.gnu.org
> 
> dmoncayo <at> gmail.com wrote:
> 
> > The following paragraph is in the info node mentioned in the subject:
> >
> >      *Note Beginning a `.emacs' File.emacs File, and *note
> >   Comments(elisp) for more about comments.
> >
> > There seems to be a problem in its first cross reference, because:
> > * The link is broken.
> > * The part ".emacs File" just after the link doesn't make sense.
> 
> I see no such problem on GNU/Linux with makeinfo 4.13 or 5.1.
> What makeinfo did you use?

I think Dany is describing the way Emacs displays that node, not the
exact text in the Info file.

The problem is in the Texinfo sources: a node name cannot include a
period, see the Texinfo manual.

Message #16 received at 15038-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: dmoncayo <at> gmail.com
Cc: 15038-done <at> debbugs.gnu.org, rgm <at> gnu.org
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 17:00:49 +0300

> Date: Wed, 07 Aug 2013 06:56:43 +0300
> From: Eli Zaretskii <eliz <at> gnu.org>
> Cc: 15038 <at> debbugs.gnu.org
> 
> > From: Glenn Morris <rgm <at> gnu.org>
> > Date: Tue, 06 Aug 2013 19:23:17 -0400
> > Cc: 15038 <at> debbugs.gnu.org
> > 
> > dmoncayo <at> gmail.com wrote:
> > 
> > > The following paragraph is in the info node mentioned in the subject:
> > >
> > >      *Note Beginning a `.emacs' File.emacs File, and *note
> > >   Comments(elisp) for more about comments.
> > >
> > > There seems to be a problem in its first cross reference, because:
> > > * The link is broken.
> > > * The part ".emacs File" just after the link doesn't make sense.
> > 
> > I see no such problem on GNU/Linux with makeinfo 4.13 or 5.1.
> > What makeinfo did you use?
> 
> I think Dany is describing the way Emacs displays that node, not the
> exact text in the Info file.
> 
> The problem is in the Texinfo sources: a node name cannot include a
> period, see the Texinfo manual.

Fixed in trunk revision 113736.

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

From: Glenn Morris <rgm <at> gnu.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org, dmoncayo <at> gmail.com
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 12:37:20 -0400

Eli Zaretskii wrote:

> I think Dany is describing the way Emacs displays that node, not the
> exact text in the Info file.

Standalone info seems to handle it fine.

> The problem is in the Texinfo sources: a node name cannot include a
> period, see the Texinfo manual.

./misc/org.texi:@node org-crypt.el,  , Interaction, Miscellaneous
./misc/edt.texi:@node edt-user.el
./misc/epa.texi:@node Encrypting/decrypting *.gpg files
./misc/cc-mode.texi:@node    Sample .emacs File, Performance Issues, Odds and Ends, Top
./misc/mairix-el.texi:@node About mairix and mairix.el
./misc/mairix-el.texi:@node Setting up mairix.el
./misc/mairix-el.texi:@node Using mairix.el
./misc/mairix-el.texi:@node Extending mairix.el

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org, dmoncayo <at> gmail.com
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 19:40:58 +0300

> From: Glenn Morris <rgm <at> gnu.org>
> Cc: dmoncayo <at> gmail.com,  15038 <at> debbugs.gnu.org
> Date: Wed, 07 Aug 2013 12:37:20 -0400
> 
> Eli Zaretskii wrote:
> 
> > I think Dany is describing the way Emacs displays that node, not the
> > exact text in the Info file.
> 
> Standalone info seems to handle it fine.

It uses a different way of finding the end of a node name (which OTOH
fails in some cases Emacs doesn't).

> > The problem is in the Texinfo sources: a node name cannot include a
> > period, see the Texinfo manual.
> 
> ./misc/org.texi:@node org-crypt.el,  , Interaction, Miscellaneous
> ./misc/edt.texi:@node edt-user.el
> ./misc/epa.texi:@node Encrypting/decrypting *.gpg files
> ./misc/cc-mode.texi:@node    Sample .emacs File, Performance Issues, Odds and Ends, Top
> ./misc/mairix-el.texi:@node About mairix and mairix.el
> ./misc/mairix-el.texi:@node Setting up mairix.el
> ./misc/mairix-el.texi:@node Using mairix.el
> ./misc/mairix-el.texi:@node Extending mairix.el

They are all in error.  From the Texinfo manual:

   * Unfortunately, you cannot reliably use periods, commas, or colons
     within a node name; these confuse the Info reader.  Also, a node
     name may not start with a left parenthesis preceding a right
     parenthesis, as in '(not)allowed', since this syntax is used to
     specify an external manual.  (Perhaps these limitations will be
     removed some day.)

     If you insist on using these characters in node names, accepting
     the resulting substandard Info output, in order not to confuse the
     Texinfo processors, you must still escape those characters, by
     using either special insertions (*note Inserting a Comma::) or
     '@asis' (*note @asis::).  For example:

          @node foo <at> asis{::}bar

     As an example of avoiding the special characters, the following is
     a section title in this manual:

          @code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading}

     But the corresponding node name lacks the commas (and the '@''s,
     but that is historical):

          unnumberedsec appendixsec heading

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

From: Glenn Morris <rgm <at> gnu.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 12:41:38 -0400

PS if parentheses are also not allowed:

./misc/reftex.texi:@node xr (LaTeX package)
./misc/reftex.texi:@node Options (Table of Contents)
./misc/reftex.texi:@node Options (Defining Label Environments)
./misc/reftex.texi:@node Options (Creating Labels)
./misc/reftex.texi:@node Options (Referencing Labels)
./misc/reftex.texi:@node Options (Creating Citations)
./misc/reftex.texi:@node Options (Index Support)
./misc/reftex.texi:@node Options (Viewing Cross-References)
./misc/reftex.texi:@node Options (Finding Files)
./misc/reftex.texi:@node Options (Optimizations)
./misc/reftex.texi:@node Options (Fontification)
./misc/reftex.texi:@node Options (Misc)

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

From: Glenn Morris <rgm <at> gnu.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org, dmoncayo <at> gmail.com
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 12:47:44 -0400

Eli Zaretskii wrote:

> They are all in error.  From the Texinfo manual:
>
>    * Unfortunately, you cannot reliably use periods, commas, or colons
>      within a node name; these confuse the Info reader.

The 4.13 manual also says "parentheses".

  * Unfortunately, you cannot use periods, commas, colons or
    parentheses within a node name; these confuse the Texinfo processors.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org, dmoncayo <at> gmail.com
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 07 Aug 2013 20:39:58 +0300

> From: Glenn Morris <rgm <at> gnu.org>
> Cc: dmoncayo <at> gmail.com,  15038 <at> debbugs.gnu.org
> Date: Wed, 07 Aug 2013 12:47:44 -0400
> 
> Eli Zaretskii wrote:
> 
> > They are all in error.  From the Texinfo manual:
> >
> >    * Unfortunately, you cannot reliably use periods, commas, or colons
> >      within a node name; these confuse the Info reader.
> 
> The 4.13 manual also says "parentheses".
> 
>   * Unfortunately, you cannot use periods, commas, colons or
>     parentheses within a node name; these confuse the Texinfo processors.

Yes, but those rarely hit the problem, if they are at the end of the
node name.

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

From: Dani Moncayo <dmoncayo <at> gmail.com>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 7 Aug 2013 20:54:40 +0200

> I see no such problem on GNU/Linux with makeinfo 4.13 or 5.1.
> What makeinfo did you use?

$ makeinfo --version
makeinfo (GNU texinfo) 4.13

(From MSYS & Windows 7)

-- 
Dani Moncayo

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

From: Dani Moncayo <dmoncayo <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 15038 <at> debbugs.gnu.org, Glenn Morris <rgm <at> gnu.org>
Subject: Re: bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"
Date: Wed, 7 Aug 2013 20:54:43 +0200

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

> I think Dany is describing the way Emacs displays that node, not the
> exact text in the Info file.

Yes, I'm attaching a screenshot of what I see in the Info buffer.

-- 
Dani Moncayo

[Capture.PNG (image/png, attachment)]

Previous Next

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