GNU bug report logs - #35793
27.0.50; Redundant "See" in the ELisp manual

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 35793 in the body.
You can then email your comments to 35793 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: Mauro Aranda <maurooaranda <at> gmail.com>
To: bug-gnu-emacs <bug-gnu-emacs <at> gnu.org>
Subject: 27.0.50; Redundant "See" in the ELisp manual
Date: Sat, 18 May 2019 17:57:08 -0300

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

Hello.

In the HTML format of the GNU Emacs Lisp Reference Manual, navigate to
the node Skipping Characters, under the node Motion.  There, look for
the cross references to Regular Expressions and to Char Classes, and
note the redundant "See".

Patch to come, once assigned a bug number.

Best regards,
Mauro.

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

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

From: Mauro Aranda <maurooaranda <at> gmail.com>
To: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Sat, 18 May 2019 18:00:19 -0300

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

Patch attached.

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

[0001-Delete-See-before-xref-or-pxref.patch (text/x-patch, attachment)]

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Mauro Aranda <maurooaranda <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Sun, 19 May 2019 08:14:40 -0400

Mauro Aranda <maurooaranda <at> gmail.com> writes:

> In the HTML format of the GNU Emacs Lisp Reference Manual, navigate to
> the node Skipping Characters, under the node Motion.  There, look for
> the cross references to Regular Expressions and to Char Classes, and
> note the redundant "See".

Hmm, the HTML output has a redundant "See", but the .info doesn't.  But
I see the texinfo manual examples don't put "see" in front of @xref, so
I guess it's just coincidence that it produces okay results for .info.

> * doc/lispref/positions.texi (Skipping Characters): Remove redundant
>   "See" before cross references.  Change @xref to @pxref, which is
>   more suitable when at the end of a sentence.  (Bug#35793)

M-x rgrep RET [Ss]ee @.\?xref RET *.texi RET doc/ RET finds a few more
hits in other manuals, could you fix those too please?

./lispref/positions.texi:843:the first letter.  See @xref{Regular Expressions}.  Character classes
./lispref/positions.texi:844:can also be used, e.g., @code{"[:alnum:]"}.  See @pxref{Char Classes}.
./lispref/modes.texi:3017:For details, see @xref{Multiline Font Lock}.
./lispref/control.texi:1454:iterators.  See @xref{Loop Facility,,,cl,Common Lisp Extensions}.
./lispref/functions.texi:2377:explicitly risky (see @pxref{File Local Variables}).
./misc/dired-x.texi:899:done.  See @xref{Optional Installation File At Point}.
./misc/dired-x.texi:907:@code{find-file-other-window}.  See @xref{Optional Installation File At Point}.
./misc/gnus-faq.texi:710:POP3 mail source.  See @pxref{Mail Source Specifiers} for VALUE.
./misc/gnus.texi:3097:See @pxref{Sieve Commands} for commands and variables that might be of
./misc/gnus.texi:3115:See @pxref{Group Mail Splitting} to automatically split on group
./misc/gnus.texi:12859:the corresponding parenthetical matches (see @xref{Replacing Match,,
./misc/gnus.texi:24245:events.  See @xref{Extending the Spam package}.
./misc/eudc.texi:609:This variable has protocol-local definitions (see @pxref{Server/Protocol
./misc/eudc.texi:717:or server local fashion (see @pxref{Server/Protocol Locals}).
./misc/dbus.texi:1931:Incoming D-Bus messages are handled as Emacs events, see @pxref{Misc
./misc/dbus.texi:1955:this message (see @pxref{Signals}).  When a @code{dbus-event} event
./misc/org.texi:10293:export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
./misc/org.texi:10359:used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
./misc/reftex.texi:3700:menu.  See @xref{Key Bindings}.
./misc/cc-mode.texi:1063:where Emacs does auto-filling (see @pxref{Custom Filling and
./misc/cc-mode.texi:1481:inserted (see @pxref{Custom Auto-newlines}).  Typically, the style
./misc/cc-mode.texi:6856:see @xref{Macros with ;}.

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

From: Mauro Aranda <maurooaranda <at> gmail.com>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Sun, 19 May 2019 10:49:21 -0300

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

Noam Postavsky <npostavs <at> gmail.com> writes:

> Mauro Aranda <maurooaranda <at> gmail.com> writes:
>
>> In the HTML format of the GNU Emacs Lisp Reference Manual, navigate to
>> the node Skipping Characters, under the node Motion.  There, look for
>> the cross references to Regular Expressions and to Char Classes, and
>> note the redundant "See".
>
> Hmm, the HTML output has a redundant "See", but the .info doesn't.  But
> I see the texinfo manual examples don't put "see" in front of @xref, so
> I guess it's just coincidence that it produces okay results for .info.

Yes.  Initially, I spotted the redundant "See" in HTML, and when I went
to my computer to fix them, I thought they were already fixed because I
couldn't see them in .info.  I don't know why .info doesn't show the
redundant "See".

>> * doc/lispref/positions.texi (Skipping Characters): Remove redundant
>>   "See" before cross references.  Change @xref to @pxref, which is
>>   more suitable when at the end of a sentence.  (Bug#35793)
>
> M-x rgrep RET [Ss]ee @.\?xref RET *.texi RET doc/ RET finds a few more
> hits in other manuals, could you fix those too please?

Of course Noam, but you should get credit for finding them.  The
attached patch should cover them.

Best regards,
Mauro.

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

[0001-Remove-redundants-See-before-xref-or-pxref-Bug-35793.patch (text/x-patch, attachment)]

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Mauro Aranda <maurooaranda <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Sun, 19 May 2019 13:13:59 -0400

Mauro Aranda <maurooaranda <at> gmail.com> writes:

> The attached patch should cover them.

I'm getting these warnings on compilation:

../../../doc/misc/gnus.texi:3099: warning: `.' or `,' must follow @xref, not `f'.
../../../doc/misc//gnus-faq.texi:710: warning: `.' or `,' must follow @xref, not `f'.

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

From: Mauro Aranda <maurooaranda <at> gmail.com>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Sun, 19 May 2019 15:21:27 -0300

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

Noam Postavsky <npostavs <at> gmail.com> writes:

> Mauro Aranda <maurooaranda <at> gmail.com> writes:
>
>> The attached patch should cover them.
>
> I'm getting these warnings on compilation:
>
> ../../../doc/misc/gnus.texi:3099: warning: `.' or `,' must follow @xref,
not `f'.
> ../../../doc/misc//gnus-faq.texi:710: warning: `.' or `,' must follow
@xref, not `f'.

Right.  My version of makeinfo (6.1) doesn't warn about that.

I added commas in both places.  I think both sentences read fine, but I
can change them if you feel that they do not.

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

[0001-Remove-redundants-See-before-xref-or-pxref-Bug-35793.patch (text/x-patch, attachment)]

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Mauro Aranda <maurooaranda <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Sun, 19 May 2019 15:06:57 -0400

Mauro Aranda <maurooaranda <at> gmail.com> writes:

>> ../../../doc/misc/gnus.texi:3099: warning: `.' or `,' must follow @xref, not `f'.
>> ../../../doc/misc//gnus-faq.texi:710: warning: `.' or `,' must follow @xref, not `f'.
>
> Right.  My version of makeinfo (6.1) doesn't warn about that.

Hmm, I'm using version 4.13 (because it's faster); if newer versions
don't warn about this, maybe we should ignore these warnings.

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

From: Mauro Aranda <maurooaranda <at> gmail.com>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Mon, 20 May 2019 17:55:46 -0300

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

Noam Postavsky <npostavs <at> gmail.com> writes:

> Mauro Aranda <maurooaranda <at> gmail.com> writes:
>
>>> ../../../doc/misc/gnus.texi:3099: warning: `.' or `,' must follow
@xref, not `f'.
>>> ../../../doc/misc//gnus-faq.texi:710: warning: `.' or `,' must follow
@xref, not `f'.
>>
>> Right.  My version of makeinfo (6.1) doesn't warn about that.
>
> Hmm, I'm using version 4.13 (because it's faster); if newer versions
> don't warn about this, maybe we should ignore these warnings.

IMO, it's fairly easy to avoid these warnings, so I wouldn't suggest
modifications that introduce them.

BTW, one of the hits you reported, namely:
./misc/gnus.texi:3115:See @pxref{Group Mail Splitting} to automatically
split on group

looks like is from the master branch and would produce the same warning
with the previous patch.

So I attach a new patch, that covers all the hits of redundant "See"s
found, and don't produce warnings, AFAICS.

Best regards,
Mauro.

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

[0001-Remove-redundants-See-before-xref-or-pxref-Bug-35793.patch (text/x-patch, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org, maurooaranda <at> gmail.com
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Wed, 22 May 2019 09:40:47 +0300

> From: Noam Postavsky <npostavs <at> gmail.com>
> Date: Sun, 19 May 2019 15:06:57 -0400
> Cc: 35793 <at> debbugs.gnu.org
> 
> Mauro Aranda <maurooaranda <at> gmail.com> writes:
> 
> >> ../../../doc/misc/gnus.texi:3099: warning: `.' or `,' must follow @xref, not `f'.
> >> ../../../doc/misc//gnus-faq.texi:710: warning: `.' or `,' must follow @xref, not `f'.
> >
> > Right.  My version of makeinfo (6.1) doesn't warn about that.
> 
> Hmm, I'm using version 4.13 (because it's faster); if newer versions
> don't warn about this, maybe we should ignore these warnings.

I'd like to keep compatibility with old Makeinfo versions, so let's
keep the commas.

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Mauro Aranda <maurooaranda <at> gmail.com>
Cc: 35793 <at> debbugs.gnu.org
Subject: Re: bug#35793: 27.0.50; Redundant "See" in the ELisp manual
Date: Sat, 25 May 2019 13:14:57 -0400

tags 35793 fixed
close 35793 26.3
quit

Mauro Aranda <maurooaranda <at> gmail.com> writes:
>
> BTW, one of the hits you reported, namely:
> ./misc/gnus.texi:3115:See @pxref{Group Mail Splitting} to automatically
> split on group
>
> looks like is from the master branch and would produce the same warning
> with the previous patch.
>
> So I attach a new patch, that covers all the hits of redundant "See"s
> found, and don't produce warnings, AFAICS.

Thanks, pushed to emacs-26, except the Mail Splitting hunk, which I
pushed to master.

7681a57b88 2019-05-25T13:02:05-04:00 "Remove redundants "See" before @xref or @pxref (Bug#35793)"
https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=7681a57b88a91bf9eedc890b974df9728d5eb50d

cd7a0bd008 2019-05-25T13:08:05-04:00 "Remove redundants "See" before @xref or @pxref (Bug#35793)"
https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=cd7a0bd00802b9331229dfe4a70ea9690d2d70fc

Previous Next

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