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

Previous Next

Package: emacs;

Reported by: Stefan Kangas <stefan <at> marxist.se>

Date: Fri, 26 Nov 2021 15:25:02 UTC

Severity: normal

Done: Stefan Kangas <stefan <at> marxist.se>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Fri, 26 Nov 2021 15:25:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Stefan Kangas <stefan <at> marxist.se>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Fri, 26 Nov 2021 15:25:02 GMT) Full text and rfc822 format available.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: Problematic characters in info node names
Date: Fri, 26 Nov 2021 16:24:15 +0100
admin/release-process says:

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

Running that gives me some matches:

doc/misc/modus-themes.texi:@node Advanced customization (do-it-yourself)
doc/misc/modus-themes.texi:@node Per-theme customization settings (DIY)
doc/misc/modus-themes.texi:@node Case-by-case face specs using the
themes' palette (DIY)
doc/misc/modus-themes.texi:@node Face specs at scale using the themes'
palette (DIY)
doc/misc/modus-themes.texi:@node Remap face with local value (DIY)
doc/misc/modus-themes.texi:@node Cycle through arbitrary colors (DIY)
doc/misc/modus-themes.texi:@node Override colors (DIY)
doc/misc/modus-themes.texi:@node Override color saturation (DIY)
doc/misc/modus-themes.texi:@node Font configurations for Org and others (DIY)
doc/misc/modus-themes.texi:@node Configure bold and italic faces (DIY)
doc/misc/modus-themes.texi:@node Custom Org user faces (DIY)
doc/misc/modus-themes.texi:@node Update Org block delimiter fontification (DIY)
doc/misc/modus-themes.texi:@node Measure color contrast (DIY)
doc/misc/modus-themes.texi:@node Load theme depending on time of day (DIY)
doc/misc/modus-themes.texi:@node Backdrop for pdf-tools (DIY)
doc/misc/modus-themes.texi:@node Decrease mode line height (DIY)
doc/misc/modus-themes.texi:@node A theme-agnostic hook for theme loading (DIY)
doc/misc/modus-themes.texi:@node Note on EWW and Elfeed fonts (SHR fonts)
doc/misc/modus-themes.texi:@node Frequently Asked Questions (FAQ)
doc/misc/org.texi:@node Hooks (2)

However, there are no instructions for what to do about these cases.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Fri, 26 Nov 2021 16:27:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 52126 <at> debbugs.gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Fri, 26 Nov 2021 18:26:23 +0200
> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Fri, 26 Nov 2021 16:24:15 +0100
> 
> admin/release-process says:
> 
> ** Manuals
> Check for node names using problematic characters:
>   find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
> Sadly makeinfo does not warn about such characters.
> 
> Running that gives me some matches:

Please report to the respective developers, but other than that, we
don't care too much.  It isn't a grave problem, and in practice slmost
never causes any trouble.

> However, there are no instructions for what to do about these cases.

There cannot be any instructions, since the manual authors should
rewrite the relevant parts not to use those characters, if possible.

Thanks.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 16:04:01 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 52126 <at> debbugs.gnu.org, Protesilaos Stavrou <info <at> protesilaos.com>,
 Kyle Meyer <kyle <at> kyleam.com>
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 17:03:03 +0100
Stefan Kangas <stefan <at> marxist.se> writes:

> ** Manuals
> Check for node names using problematic characters:
>   find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
> Sadly makeinfo does not warn about such characters.
>
> Running that gives me some matches:
>
> doc/misc/modus-themes.texi:@node Advanced customization (do-it-yourself)
> doc/misc/modus-themes.texi:@node Per-theme customization settings (DIY)

(etc)

I think this has to be fixed in the Modus manual, so I've added
Protesilaos to the CCs.  (The issue is that parentheses aren't valid in
texinfo node names, apparently.)

> doc/misc/org.texi:@node Hooks (2)

And in the Org manual, so I've added Kyle to the CCs, too.

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




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 17:45:02 GMT) Full text and rfc822 format available.

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

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: Re: 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.)




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 17:53:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, info <at> protesilaos.com, rgm <at> gnu.org,
 kyle <at> kyleam.com
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 19:52:57 +0200
> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Mon, 29 Nov 2021 09:44:17 -0800
> Cc: 52126 <at> debbugs.gnu.org, Protesilaos Stavrou <info <at> protesilaos.com>,
>  Kyle Meyer <kyle <at> kyleam.com>, Glenn Morris <rgm <at> gnu.org>
> 
> 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.)

This is mainly because of the stand-alone Info reader.  The Emacs Info
mode copes with these characters in node names much better.

So yes, it is desirable to avoid them, but it isn't a catastrophe if
they are there.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 18:05:01 GMT) Full text and rfc822 format available.

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

From: Protesilaos Stavrou <info <at> protesilaos.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, Stefan Kangas <stefan <at> marxist.se>,
 kyle <at> kyleam.com, rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 20:04:37 +0200
On 2021-11-29, 19:52 +0200, Eli Zaretskii <eliz <at> gnu.org> wrote:

>> From: Stefan Kangas <stefan <at> marxist.se>
>> Date: Mon, 29 Nov 2021 09:44:17 -0800
>> Cc: 52126 <at> debbugs.gnu.org, Protesilaos Stavrou <info <at> protesilaos.com>,
>>  Kyle Meyer <kyle <at> kyleam.com>, Glenn Morris <rgm <at> gnu.org>
>> 
>> 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.)
>
> This is mainly because of the stand-alone Info reader.  The Emacs Info
> mode copes with these characters in node names much better.
>
> So yes, it is desirable to avoid them, but it isn't a catastrophe if
> they are there.

Thanks!

I just removed the problematic characters from my repo.  Though this
change will be brought into emacs.git as part of my next tagged release
(in a few weeks).

Two questions then:

1. Do you want me to change this now on the trunk?
2. This affects the emacs-28 branch.  Should I patch that as well?

-- 
Protesilaos Stavrou
https://protesilaos.com




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 18:08:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Protesilaos Stavrou <info <at> protesilaos.com>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 20:07:54 +0200
> From: Protesilaos Stavrou <info <at> protesilaos.com>
> Cc: larsi <at> gnus.org, Stefan Kangas <stefan <at> marxist.se>,
>  52126 <at> debbugs.gnu.org, kyle <at> kyleam.com, rgm <at> gnu.org
> Date: Mon, 29 Nov 2021 20:04:37 +0200
> 
> 1. Do you want me to change this now on the trunk?

Yes.

> 2. This affects the emacs-28 branch.  Should I patch that as well?

It's up to you.  It isn't important either way.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 18:18:02 GMT) Full text and rfc822 format available.

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

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

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

Yes. It's easy to find old versions of the Texinfo manual, eg
http://www.nongnu.org/texi2latex/texinfo/Node-Line-Requirements.html

Newer Texinfo is less strict, but Emacs configure still claims to
support 4.13.

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

It never did warn about such things; it made no sense to me.

https://lists.gnu.org/r/bug-texinfo/2013-08/msg00008.html




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 18:32:01 GMT) Full text and rfc822 format available.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, info <at> protesilaos.com, rgm <at> gnu.org,
 kyle <at> kyleam.com
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 10:31:50 -0800
Eli Zaretskii <eliz <at> gnu.org> writes:

>> 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.)
>
> This is mainly because of the stand-alone Info reader.  The Emacs Info
> mode copes with these characters in node names much better.
>
> So yes, it is desirable to avoid them, but it isn't a catastrophe if
> they are there.

I guess what I'm asking myself if its useful to keep this advice in
admin/release-process.

Personally, I have no strong opinion either way, but I note that
makeinfo seems to now claim to warn about any problematic cases.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 19:34:01 GMT) Full text and rfc822 format available.

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

From: Protesilaos Stavrou <info <at> protesilaos.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 21:32:44 +0200
[Message part 1 (text/plain, inline)]
On 2021-11-29, 20:07 +0200, Eli Zaretskii <eliz <at> gnu.org> wrote:

>> From: Protesilaos Stavrou <info <at> protesilaos.com>
>> Cc: larsi <at> gnus.org, Stefan Kangas <stefan <at> marxist.se>,
>>  52126 <at> debbugs.gnu.org, kyle <at> kyleam.com, rgm <at> gnu.org
>> Date: Mon, 29 Nov 2021 20:04:37 +0200
>> 
>> 1. Do you want me to change this now on the trunk?
>
> Yes.
>
>> 2. This affects the emacs-28 branch.  Should I patch that as well?
>
> It's up to you.  It isn't important either way.

Both patches are attached.  Each file name contains the Emacs version it
belongs to.

I can push directly from here if you think everything is in order.

-- 
Protesilaos Stavrou
https://protesilaos.com
[0001-Remove-problematic-characters-from-modus-themes-emacs28.patch (text/x-patch, attachment)]
[0001-Remove-problematic-characters-from-modus-themes-emacs29.patch (text/x-patch, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 19:47:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Protesilaos Stavrou <info <at> protesilaos.com>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 21:46:08 +0200
> From: Protesilaos Stavrou <info <at> protesilaos.com>
> Cc: larsi <at> gnus.org, stefan <at> marxist.se, 52126 <at> debbugs.gnu.org,
>  kyle <at> kyleam.com, rgm <at> gnu.org
> Date: Mon, 29 Nov 2021 21:32:44 +0200
> 
> >> 2. This affects the emacs-28 branch.  Should I patch that as well?
> >
> > It's up to you.  It isn't important either way.
> 
> Both patches are attached.  Each file name contains the Emacs version it
> belongs to.
> 
> I can push directly from here if you think everything is in order.

Feel free to push to any of the two branches.

Thanks.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 20:09:01 GMT) Full text and rfc822 format available.

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

From: Protesilaos Stavrou <info <at> protesilaos.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 22:07:58 +0200
On 2021-11-29, 21:46 +0200, Eli Zaretskii <eliz <at> gnu.org> wrote:

>> From: Protesilaos Stavrou <info <at> protesilaos.com>
>> Cc: larsi <at> gnus.org, stefan <at> marxist.se, 52126 <at> debbugs.gnu.org,
>>  kyle <at> kyleam.com, rgm <at> gnu.org
>> Date: Mon, 29 Nov 2021 21:32:44 +0200
>> 
>> >> 2. This affects the emacs-28 branch.  Should I patch that as well?
>> >
>> > It's up to you.  It isn't important either way.
>> 
>> Both patches are attached.  Each file name contains the Emacs version it
>> belongs to.
>> 
>> I can push directly from here if you think everything is in order.
>
> Feel free to push to any of the two branches.
>
> Thanks.

Done for both.  Thank you!

-- 
Protesilaos Stavrou
https://protesilaos.com




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 20:33:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Protesilaos Stavrou <info <at> protesilaos.com>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 22:32:57 +0200
> From: Protesilaos Stavrou <info <at> protesilaos.com>
> Cc: larsi <at> gnus.org, stefan <at> marxist.se, 52126 <at> debbugs.gnu.org,
>  kyle <at> kyleam.com, rgm <at> gnu.org
> Date: Mon, 29 Nov 2021 22:07:58 +0200
> 
> On 2021-11-29, 21:46 +0200, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
> >> Both patches are attached.  Each file name contains the Emacs version it
> >> belongs to.
> >> 
> >> I can push directly from here if you think everything is in order.
> >
> > Feel free to push to any of the two branches.
> >
> > Thanks.
> 
> Done for both.  Thank you!

You should have only pushed to one of the branches, not to both.
Because they are the same changes, right?




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Mon, 29 Nov 2021 20:57:01 GMT) Full text and rfc822 format available.

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

From: Protesilaos Stavrou <info <at> protesilaos.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 22:56:29 +0200
On 2021-11-29, 22:32 +0200, Eli Zaretskii <eliz <at> gnu.org> wrote:

>> From: Protesilaos Stavrou <info <at> protesilaos.com>
>> Cc: larsi <at> gnus.org, stefan <at> marxist.se, 52126 <at> debbugs.gnu.org,
>>  kyle <at> kyleam.com, rgm <at> gnu.org
>> Date: Mon, 29 Nov 2021 22:07:58 +0200
>> 
>> On 2021-11-29, 21:46 +0200, Eli Zaretskii <eliz <at> gnu.org> wrote:
>> 
>> >> Both patches are attached.  Each file name contains the Emacs version it
>> >> belongs to.
>> >> 
>> >> I can push directly from here if you think everything is in order.
>> >
>> > Feel free to push to any of the two branches.
>> >
>> > Thanks.
>> 
>> Done for both.  Thank you!
>
> You should have only pushed to one of the branches, not to both.
> Because they are the same changes, right?

There is a slight difference between them.  The one for the master
branch has an extra diff hunk which removes a single "(DIY)" from a
heading.  This is because emacs-28 has version 1.6.0 of the themes while
master has 1.7.0.

Commit 030a5c5704 on master:

   doc/misc/modus-themes.org | 68 +++++++++++++++++++++++------------------------

Commit ecf3bf66ba on emacs-28:

   doc/misc/modus-themes.org | 66 +++++++++++++++++++++++------------------------

-- 
Protesilaos Stavrou
https://protesilaos.com




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Tue, 30 Nov 2021 03:25:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Protesilaos Stavrou <info <at> protesilaos.com>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Tue, 30 Nov 2021 05:25:00 +0200
> From: Protesilaos Stavrou <info <at> protesilaos.com>
> Cc: larsi <at> gnus.org, stefan <at> marxist.se, 52126 <at> debbugs.gnu.org,
>  kyle <at> kyleam.com, rgm <at> gnu.org
> Date: Mon, 29 Nov 2021 22:56:29 +0200
> 
> >> Done for both.  Thank you!
> >
> > You should have only pushed to one of the branches, not to both.
> > Because they are the same changes, right?
> 
> There is a slight difference between them.  The one for the master
> branch has an extra diff hunk which removes a single "(DIY)" from a
> heading.  This is because emacs-28 has version 1.6.0 of the themes while
> master has 1.7.0.

The common part should only be committed to one branch.
Alternatively, the commit to emacs-28 should be marked with the "do
not merge to master" note.  See CONTRIBUTE for more about this.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Tue, 30 Nov 2021 04:32:02 GMT) Full text and rfc822 format available.

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

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

> Stefan Kangas wrote:
>
>> Did something change here since the above note in admin/release-process
>> was written in 2013 (commit 16bcc96df4)?
>
> Yes. It's easy to find old versions of the Texinfo manual, eg
> http://www.nongnu.org/texi2latex/texinfo/Node-Line-Requirements.html
>
> Newer Texinfo is less strict, but Emacs configure still claims to
> support 4.13.

I wonder whether 4.13 actually has a problem with the cases flagged in
this issue, where the parentheses are not at the start of the text.
Texinfo's ab404029d0 (parens only disallowed when looks like an external
manual ref, 2011-09-18) made the following text change:

   @cindex Characters, invalid in node name
   @cindex Invalid characters in node names
   @cindex Node names, invalid characters in
  -Unfortunately, you cannot use periods, commas, colons or parentheses
  -within a node name; these confuse the Texinfo processors.  Perhaps
  -this limitation will be removed some day, too.
  +Unfortunately, you cannot use periods, commas, or colons within a node
  +name; these confuse the Texinfo processors.  Also, a node name may not
  +start with a left parenthesis and contain a right parenthesis, as in
  +@code{(not)allowed}; this specifies an external manual in Info.
  +Perhaps these limitations will be removed some day, too.

That looks to be a pure documentation update to more accurately describe
the restrictions.  The commit message links to a thread [*] that seems
to confirm that.  There Patrice Dumas says

  What is not allowed, in reality, and leads to an error message is parentheses
  beginning at the beginning of the node name as you said:
  
   @node (man)bad
  
   c.texi:6: Syntax for an external node used for `(man)bad'

[*] https://lists.gnu.org/archive/html/bug-texinfo/2011-09/msg00024.html




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Tue, 30 Nov 2021 04:41:02 GMT) Full text and rfc822 format available.

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

From: Kyle Meyer <kyle <at> kyleam.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 52126 <at> debbugs.gnu.org, Protesilaos Stavrou <info <at> protesilaos.com>,
 Stefan Kangas <stefan <at> marxist.se>
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 23:39:55 -0500
Lars Ingebrigtsen writes:

> Stefan Kangas <stefan <at> marxist.se> writes:
>
>> ** Manuals
>> Check for node names using problematic characters:
>>   find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
>> Sadly makeinfo does not warn about such characters.
>>
>> Running that gives me some matches:
[...]
>> doc/misc/org.texi:@node Hooks (2)
>
> And in the Org manual, so I've added Kyle to the CCs, too.

Hmm, that "(2)" is being added by ox-texinfo.el's to make the node
unique.  As I mentioned in another message
(<87tufue02l.fsf <at> kyleam.com>), I think these parentheses are probably
okay, even for older versions of Texinfo.

On the other hand, I have no objections to sidestepping the issue with
something like this:

diff --git a/doc/misc/org.org b/doc/misc/org.org
index 85117714ee9..adf24da1c3f 100644
--- a/doc/misc/org.org
+++ b/doc/misc/org.org
@@ -15571,7 +15571,7 @@ ** Advanced Export Configuration
 :DESCRIPTION: Fine-tuning the export output.
 :END:
 
-*** Hooks
+*** Export hooks
 :PROPERTIES:
 :UNNUMBERED: notoc
 :END:
@@ -18203,7 +18203,7 @@ *** Functions
   #+kindex: C-c C-v f
   Choose a file to tangle.  Bound to {{{kbd(C-c C-v f)}}}.
 
-*** Hooks
+*** Tangle hooks
 :PROPERTIES:
 :UNNUMBERED: notoc
 :END:




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Tue, 30 Nov 2021 06:40:02 GMT) Full text and rfc822 format available.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>, Protesilaos Stavrou <info <at> protesilaos.com>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, kyle <at> kyleam.com, rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 22:39:53 -0800
Eli Zaretskii <eliz <at> gnu.org> writes:

> The common part should only be committed to one branch.
> Alternatively, the commit to emacs-28 should be marked with the "do
> not merge to master" note.  See CONTRIBUTE for more about this.

Yup.

Otherwise, I get to resolve merge conflicts over my morning coffee.  :-)

    There are unresolved conflicts in .../emacs/doc/misc/modus-themes.org
    Conflicts in:
    doc/misc/modus-themes.org

    Resolve the conflicts manually
    automerge: merge error

It's not the end of the world, but it saves time if we can avoid it.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Tue, 30 Nov 2021 07:17:02 GMT) Full text and rfc822 format available.

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

From: Protesilaos Stavrou <info <at> protesilaos.com>
To: Stefan Kangas <stefan <at> marxist.se>, Eli Zaretskii <eliz <at> gnu.org>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, kyle <at> kyleam.com, rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Tue, 30 Nov 2021 09:16:02 +0200
On 2021-11-29, 22:39 -0800, Stefan Kangas <stefan <at> marxist.se> wrote:

> Eli Zaretskii <eliz <at> gnu.org> writes:
>
>> The common part should only be committed to one branch.
>> Alternatively, the commit to emacs-28 should be marked with the "do
>> not merge to master" note.  See CONTRIBUTE for more about this.
>
> Yup.
>
> Otherwise, I get to resolve merge conflicts over my morning coffee.  :-)
>
>     There are unresolved conflicts in .../emacs/doc/misc/modus-themes.org
>     Conflicts in:
>     doc/misc/modus-themes.org
>
>     Resolve the conflicts manually
>     automerge: merge error
>
> It's not the end of the world, but it saves time if we can avoid it.

I understand, re-read CONTRIBUTE, and apologise for the inconvenience.

Should I then revert the commit in master and apply to it the 1
difference I mentioned before?  Just asking so that we do not commit
multiple times.

I noticed in 0854453ec2343cbfac3ac8e233cdc7bd2c8554a9 a pattern for how
reverted commits should be written.  I can follow that.

-- 
Protesilaos Stavrou
https://protesilaos.com




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Tue, 30 Nov 2021 07:42:01 GMT) Full text and rfc822 format available.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Protesilaos Stavrou <info <at> protesilaos.com>, Eli Zaretskii <eliz <at> gnu.org>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, kyle <at> kyleam.com, rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Mon, 29 Nov 2021 23:41:42 -0800
Protesilaos Stavrou <info <at> protesilaos.com> writes:

> I understand, re-read CONTRIBUTE, and apologise for the inconvenience.

No need to apologize.  It happens!

> Should I then revert the commit in master and apply to it the 1
> difference I mentioned before?  Just asking so that we do not commit
> multiple times.

It's better to just leave it alone for now, as it's already been merged
to master.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Tue, 30 Nov 2021 16:49:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Protesilaos Stavrou <info <at> protesilaos.com>
Cc: 52126 <at> debbugs.gnu.org, larsi <at> gnus.org, stefan <at> marxist.se, kyle <at> kyleam.com,
 rgm <at> gnu.org
Subject: Re: bug#52126: Problematic characters in info node names
Date: Tue, 30 Nov 2021 18:48:44 +0200
> From: Protesilaos Stavrou <info <at> protesilaos.com>
> Cc: larsi <at> gnus.org, 52126 <at> debbugs.gnu.org, kyle <at> kyleam.com, rgm <at> gnu.org
> Date: Tue, 30 Nov 2021 09:16:02 +0200
> 
> I noticed in 0854453ec2343cbfac3ac8e233cdc7bd2c8554a9 a pattern for how
> reverted commits should be written.  I can follow that.

You don't have to: the pattern is produced by Git itself, and if you
want to add or change something, invoke "git revert -e".




Reply sent to Stefan Kangas <stefan <at> marxist.se>:
You have taken responsibility. (Fri, 03 Dec 2021 01:13:03 GMT) Full text and rfc822 format available.

Notification sent to Stefan Kangas <stefan <at> marxist.se>:
bug acknowledged by developer. (Fri, 03 Dec 2021 01:13:03 GMT) Full text and rfc822 format available.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Kyle Meyer <kyle <at> kyleam.com>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 52126-done <at> debbugs.gnu.org,
 Protesilaos Stavrou <info <at> protesilaos.com>
Subject: Re: bug#52126: Problematic characters in info node names
Date: Thu, 2 Dec 2021 17:12:22 -0800
Kyle Meyer <kyle <at> kyleam.com> writes:

> Hmm, that "(2)" is being added by ox-texinfo.el's to make the node
> unique.  As I mentioned in another message
> (<87tufue02l.fsf <at> kyleam.com>), I think these parentheses are probably
> okay, even for older versions of Texinfo.
>
> On the other hand, I have no objections to sidestepping the issue with
> something like this:

Thanks, that looks like a reasonable fix.  None of this seems urgent to
me, so I'd suggest you consider pushing that fix to the Org-mode
repository and we will eventually get it merged into Emacs in the normal
way.

With that, I'm closing this bug as it seems the issues here are resolved.

Thanks.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#52126; Package emacs. (Fri, 03 Dec 2021 01:46:01 GMT) Full text and rfc822 format available.

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

From: Kyle Meyer <kyle <at> kyleam.com>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 52126-done <at> debbugs.gnu.org,
 Protesilaos Stavrou <info <at> protesilaos.com>
Subject: Re: bug#52126: Problematic characters in info node names
Date: Thu, 02 Dec 2021 20:45:18 -0500
Stefan Kangas writes:

> Thanks, that looks like a reasonable fix.  None of this seems urgent to
> me, so I'd suggest you consider pushing that fix to the Org-mode
> repository and we will eventually get it merged into Emacs in the normal
> way.

Pushed to the Org repo (0acd2fed2).




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Fri, 31 Dec 2021 12:24:05 GMT) Full text and rfc822 format available.

This bug report was last modified 2 years and 78 days ago.

Previous Next


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