bug#35793: 27.0.50; Redundant "See" in the ELisp manual

[Mauro Aranda <maurooaranda@gmail.com>]

[-- Attachment #1.1: Type: text/plain, Size: 946 bytes --]

Noam Postavsky <npostavs@gmail.com> writes:

> Mauro Aranda <maurooaranda@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.

[-- Attachment #1.2: Type: text/html, Size: 1258 bytes --]

[-- Attachment #2: 0001-Remove-redundants-See-before-xref-or-pxref-Bug-35793.patch --]
[-- Type: text/x-patch, Size: 12247 bytes --]

From 11738459f049f80cd8f4bfd6941024268dbf2965 Mon Sep 17 00:00:00 2001
From: Mauro Aranda <maurooaranda@gmail.com>
Date: Sat, 18 May 2019 17:35:04 -0300
Subject: [PATCH] Remove redundants "See" before @xref or @pxref (Bug#35793)

* doc/lispref/control.texi (Control Structures):
* doc/lispref/modes.texi (Search-based Fontification):
* doc/misc/cc-mode.texi (Filling and Line Breaking Commands)
(Auto-newline Insertion, Other Special Indentations):
* doc/misc/dbus.texi (Errors and Events):
* doc/misc/dired-x.texi (Find File At Point):
* doc/misc/eudc.texi (Display of Query Results, Inline Query Expansion):
* doc/misc/gnus-faq.texi (FAQ 3-11):
* doc/misc/gnus.texi (Group Parameters, Posting Styles)
(Spam Package Introduction):
* doc/misc/org.texi (LaTeX fragments, Previewing LaTeX fragments):
* doc/misc/reftex.texi (Commands):
Remove redundant "See" before cross references.
* doc/lispref/functions.texi (Function Safety): Redundant "see" is in
ignored text, but remove it anyway.
* 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.

Most of the redundants "See" found by Noam Postavsky.
---
 doc/lispref/control.texi   |  2 +-
 doc/lispref/functions.texi |  2 +-
 doc/lispref/modes.texi     |  2 +-
 doc/lispref/positions.texi |  4 ++--
 doc/misc/cc-mode.texi      |  6 +++---
 doc/misc/dbus.texi         |  4 ++--
 doc/misc/dired-x.texi      |  4 ++--
 doc/misc/eudc.texi         |  4 ++--
 doc/misc/gnus-faq.texi     |  2 +-
 doc/misc/gnus.texi         | 10 +++++-----
 doc/misc/org.texi          |  4 ++--
 doc/misc/reftex.texi       |  2 +-
 12 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi
index 5d4184e..e308d68 100644
--- a/doc/lispref/control.texi
+++ b/doc/lispref/control.texi
@@ -1451,7 +1451,7 @@ Generators
 @end defmac
 
 The Common Lisp loop facility also contains features for working with
-iterators.  See @xref{Loop Facility,,,cl,Common Lisp Extensions}.
+iterators.  @xref{Loop Facility,,,cl,Common Lisp Extensions}.
 
 The following piece of code demonstrates some important principles of
 working with iterators.
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index 97f7fb9..e3d64a7 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -2374,7 +2374,7 @@ Function Safety
 A form that creates temporary bindings (@code{condition-case},
 @code{dolist}, @code{dotimes}, @code{lambda}, @code{let}, or
 @code{let*}), if all args are safe and the symbols to be bound are not
-explicitly risky (see @pxref{File Local Variables}).
+explicitly risky (@pxref{File Local Variables}).
 @item
 An assignment using @code{add-to-list}, @code{setq}, @code{push}, or
 @code{pop}, if all args are safe and the symbols to be assigned are
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index 97e9be9..9d95063 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -3014,7 +3014,7 @@ Search-based Fontification
 
 @strong{Warning:} Do not design an element of @code{font-lock-keywords}
 to match text which spans lines; this does not work reliably.
-For details, see @xref{Multiline Font Lock}.
+For details, @pxref{Multiline Font Lock}.
 
 You can use @var{case-fold} in @code{font-lock-defaults} to specify
 the value of @code{font-lock-keywords-case-fold-search} which says
diff --git a/doc/lispref/positions.texi b/doc/lispref/positions.texi
index 527a3ab..7707793 100644
--- a/doc/lispref/positions.texi
+++ b/doc/lispref/positions.texi
@@ -840,8 +840,8 @@ Skipping Characters
 terminate it, and @samp{\} quotes @samp{^}, @samp{-} or @samp{\}.
 Thus, @code{"a-zA-Z"} skips over all letters, stopping before the
 first nonletter, and @code{"^a-zA-Z"} skips nonletters stopping before
-the first letter.  See @xref{Regular Expressions}.  Character classes
-can also be used, e.g., @code{"[:alnum:]"}.  See @pxref{Char Classes}.
+the first letter (@pxref{Regular Expressions}).  Character classes
+can also be used, e.g., @code{"[:alnum:]"} (@pxref{Char Classes}).
 
 If @var{limit} is supplied (it must be a number or a marker), it
 specifies the maximum position in the buffer that point can be skipped
diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi
index 6db2c96..df6709e 100644
--- a/doc/misc/cc-mode.texi
+++ b/doc/misc/cc-mode.texi
@@ -1060,7 +1060,7 @@ Filling and Breaking
 and so on.
 
 You can configure the exact way comments get filled and broken, and
-where Emacs does auto-filling (see @pxref{Custom Filling and
+where Emacs does auto-filling (@pxref{Custom Filling and
 Breaking}).  Typically, the style system (@pxref{Styles}) will have
 set this up for you, so you probably won't have to bother.
 
@@ -1478,7 +1478,7 @@ Auto-newlines
 @end itemize
 
 You can configure the precise circumstances in which newlines get
-inserted (see @pxref{Custom Auto-newlines}).  Typically, the style
+inserted (@pxref{Custom Auto-newlines}).  Typically, the style
 system (@pxref{Styles}) will have set this up for you, so you probably
 won't have to bother.
 
@@ -6853,7 +6853,7 @@ Other Indentation
 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 To configure macros which you invoke without a terminating @samp{;},
-see @xref{Macros with ;}.
+@pxref{Macros with ;}.
 
 Here are the remaining odds and ends regarding indentation:
 
diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi
index c7d4998..7c7612f 100644
--- a/doc/misc/dbus.texi
+++ b/doc/misc/dbus.texi
@@ -1928,7 +1928,7 @@ Errors and Events
 errors can be made visible when @code{dbus-debug} is set to @code{t}.
 @end defspec
 
-Incoming D-Bus messages are handled as Emacs events, see @pxref{Misc
+Incoming D-Bus messages are handled as Emacs events, @pxref{Misc
 Events, , , elisp}.  They are retrieved only, when Emacs runs in
 interactive mode.  The generated event has this form:
 
@@ -1952,7 +1952,7 @@ Errors and Events
 @var{member} denote the message which has been sent.
 
 @var{handler} is the callback function which has been registered for
-this message (see @pxref{Signals}).  When a @code{dbus-event} event
+this message (@pxref{Signals}).  When a @code{dbus-event} event
 arrives, @var{handler} is called with @var{args} as arguments.
 
 In order to inspect the @code{dbus-event} data, you could extend the
diff --git a/doc/misc/dired-x.texi b/doc/misc/dired-x.texi
index b6a9d23..1e34145 100644
--- a/doc/misc/dired-x.texi
+++ b/doc/misc/dired-x.texi
@@ -896,7 +896,7 @@ Find File At Point
 @code{find-file-other-window}.  If you change this variable after
 @file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}.  The
 default value of this variable is @code{t}; by default, the binding is not
-done.  See @xref{Optional Installation File At Point}.
+done.  @xref{Optional Installation File At Point}.
 
 @item dired-x-bind-find-file
 @findex dired-x-bind-find-file
@@ -904,7 +904,7 @@ Find File At Point
 that uses the value of @code{dired-x-hands-off-my-keys} to determine if
 @code{dired-x-find-file} should be bound over @code{find-file} and
 @code{dired-x-find-file-other-window} bound over
-@code{find-file-other-window}.  See @xref{Optional Installation File At Point}.
+@code{find-file-other-window}.  @xref{Optional Installation File At Point}.
 @end table
 
 @node Miscellaneous Commands
diff --git a/doc/misc/eudc.texi b/doc/misc/eudc.texi
index 117b62e..568f94b 100644
--- a/doc/misc/eudc.texi
+++ b/doc/misc/eudc.texi
@@ -606,7 +606,7 @@ Display of Query Results
 display.
 @end defvar
 
-This variable has protocol-local definitions (see @pxref{Server/Protocol
+This variable has protocol-local definitions (@pxref{Server/Protocol
 Locals}).  For instance, it is defined as follows for LDAP:
 
 @lisp
@@ -714,7 +714,7 @@ Inline Query Expansion
 @var{format}s are in fact not limited to EUDC attribute names, you can
 use server or protocol specific names in them.  It may be safer if you
 do so, to set the variable @code{eudc-inline-query-format} in a protocol
-or server local fashion (see @pxref{Server/Protocol Locals}).
+or server local fashion (@pxref{Server/Protocol Locals}).
 
 For instance you could use the following to match up to three words
 against the @code{cn} attribute of LDAP servers:
diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi
index 075f521..840cc08 100644
--- a/doc/misc/gnus-faq.texi
+++ b/doc/misc/gnus-faq.texi
@@ -707,7 +707,7 @@ FAQ 3-11
 
 Yes, if the POP3 server supports the UIDL control (maybe almost servers
 do it nowadays).  To do that, add a @code{:leave VALUE} pair to each
-POP3 mail source.  See @pxref{Mail Source Specifiers} for VALUE.
+POP3 mail source.  @xref{Mail Source Specifiers}, for details on VALUE.
 
 @node FAQ 4 - Reading messages
 @subsection Reading messages
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index b9c91a0..387c04f 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -3094,7 +3094,7 @@ Group Parameters
 (sieve header :regex "list-id" "<c++std-\\1.accu.org>")
 @end example
 
-See @pxref{Sieve Commands} for commands and variables that might be of
+@xref{Sieve Commands}, for commands and variables that might be of
 interest in relation to the sieve parameter.
 
 The Sieve language is described in RFC 3028.  @xref{Top, Emacs Sieve,
@@ -3112,8 +3112,8 @@ Group Parameters
 See @code{nnmail-split-abbrev-alist} for the regular expression
 matching mailing-list headers.
 
-See @pxref{Group Mail Splitting} to automatically split on group
-parameters.
+@xref{Group Mail Splitting}, for details on how to automatically split
+on group parameters.
 
 @item (agent parameters)
 If the agent has been enabled, you can set any of its parameters to
@@ -12856,7 +12856,7 @@ Posting Styles
 expression, or if it takes the form @code{(header @var{match}
 @var{regexp})}, a @samp{gnus-match-substitute-replacement} is proceed
 on the value to replace the positional parameters @samp{\@var{n}} by
-the corresponding parenthetical matches (see @xref{Replacing Match,,
+the corresponding parenthetical matches (@pxref{Replacing Match,,
 Replacing the Text that Matched, elisp, The Emacs Lisp Reference
 Manual}.)
 
@@ -24242,7 +24242,7 @@ Spam Package Introduction
 Do not skip, speed-read, or glance through this section.
 
 Make sure you read the section on the @code{spam.el} sequence of
-events.  See @xref{Extending the Spam package}.
+events.  @xref{Extending the Spam package}.
 
 @cindex spam-initialize
 @vindex spam-use-stat
diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index 7862713..185033e 100644
--- a/doc/misc/org.texi
+++ b/doc/misc/org.texi
@@ -10290,7 +10290,7 @@ @LaTeX{} fragments
 these for several export back-ends.  When exporting to @LaTeX{}, the code is
 left as it is.  When exporting to HTML, Org can use either
 @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML
-export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
+export}) or transcode the math into images (@pxref{Previewing @LaTeX{}
 fragments}).
 
 @LaTeX{} fragments don't need any special marking at all.  The following
@@ -10356,7 +10356,7 @@ Previewing @LaTeX{} fragments
 and from the @file{imagemagick} suite.  Choose the converter by setting the
 variable @code{org-preview-latex-default-process} accordingly.}, @LaTeX{}
 fragments can be processed to produce images of the typeset expressions to be
-used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
+used for inclusion while exporting to HTML (@pxref{@LaTeX{} fragments}),
 or for inline previewing within Org mode.
 
 @vindex org-format-latex-options
diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi
index baa8de4..8221abd 100644
--- a/doc/misc/reftex.texi
+++ b/doc/misc/reftex.texi
@@ -3697,7 +3697,7 @@ Commands
 Here is a summary of @RefTeX{}'s commands which can be executed from
 @LaTeX{} files.  Command which are executed from the special buffers are
 not described here.  All commands are available from the @code{Ref}
-menu.  See @xref{Key Bindings}.
+menu.  @xref{Key Bindings}.
 
 @deffn Command reftex-toc
 Show the table of contents for the current document.  When called with
-- 
2.7.4