GNU bug report logs - #52126
Problematic characters in info node names

Previous Next

Full log

View this message in rfc822 format

From: Stefan Kangas <stefan <at> marxist.se>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 52126 <at> debbugs.gnu.org, Protesilaos Stavrou <info <at> protesilaos.com>, Kyle Meyer <kyle <at> kyleam.com>, Glenn Morris <rgm <at> gnu.org>
Subject: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 09:44:17 -0800

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

>> ** Manuals
>> Check for node names using problematic characters:
>>   find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
>> Sadly makeinfo does not warn about such characters.

Did something change here since the above note in admin/release-process
was written in 2013 (commit 16bcc96df4)?

I read in (info "(texinfo) Node Line Requirements") that:

   * Unfortunately, you cannot reliably use periods, commas, or colons
     within a node name; these can 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.)

     'makeinfo' warns about such problematic usage in node names, menu
     items, and cross-references.  If you don't want to see the
     warnings, you can set the customization variable
     'INFO_SPECIAL_CHARS_WARNING' to '0' (*note Other Customization
     Variables::).

(Though I can't see any warnings produced when running "make info" in a
fresh tree.)

Previous Next

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