bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[dmoncayo]

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@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''

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Glenn Morris]

dmoncayo@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)

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Eli Zaretskii]

> From: Glenn Morris <rgm@gnu.org>
> Date: Tue, 06 Aug 2013 19:23:17 -0400
> Cc: 15038@debbugs.gnu.org
> 
> dmoncayo@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.

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Eli Zaretskii]

> Date: Wed, 07 Aug 2013 06:56:43 +0300
> From: Eli Zaretskii <eliz@gnu.org>
> Cc: 15038@debbugs.gnu.org
> 
> > From: Glenn Morris <rgm@gnu.org>
> > Date: Tue, 06 Aug 2013 19:23:17 -0400
> > Cc: 15038@debbugs.gnu.org
> > 
> > dmoncayo@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.

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Glenn Morris]

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

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Eli Zaretskii]

> From: Glenn Morris <rgm@gnu.org>
> Cc: dmoncayo@gmail.com,  15038@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@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

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Glenn Morris]

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)

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Glenn Morris]

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.

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Eli Zaretskii]

> From: Glenn Morris <rgm@gnu.org>
> Cc: dmoncayo@gmail.com,  15038@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.

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Dani Moncayo]

> 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

bug#15038: 24.3.50; Doc bug in "(eintr) Change a defun"

[Dani Moncayo]

[-- Attachment #1: Type: text/plain, Size: 187 bytes --]

> 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

[-- Attachment #2: Capture.PNG --]
[-- Type: image/png, Size: 2949 bytes --]