manual: Fix Texinfo warnings about improper node names.

Message ID 20180207065017.6962-1-ricaljasan@pacific.net
State New
Headers show
Series
  • manual: Fix Texinfo warnings about improper node names.
Related show

Commit Message

Rical Jasan Feb. 7, 2018, 6:50 a.m.
A number of cross-references to the GCC info manual cause Texinfo
warnings; e.g.:

  ./creature.texi:11: warning: @xref node name should not contain `.'

This is due to "gcc.info" being used in the INFO-FILE-NAME (fourth)
argument.  Changing it to "gcc" removes these warnings.  (Manually
confirmed equivalent behaviour for make info, html, and pdf.)

	* manual/creature.texi: Convert references to gcc.info to gcc.
	* manual/stdio.texi: Likewise.
	* manual/string.texi: Likewise.
---
 manual/creature.texi | 2 +-
 manual/stdio.texi    | 8 ++++----
 manual/string.texi   | 2 +-
 3 files changed, 6 insertions(+), 6 deletions(-)

Comments

Andreas Schwab Feb. 7, 2018, 8:54 a.m. | #1
On Feb 06 2018, Rical Jasan <ricaljasan@pacific.net> wrote:

> A number of cross-references to the GCC info manual cause Texinfo
> warnings; e.g.:
>
>   ./creature.texi:11: warning: @xref node name should not contain `.'

This is a strange warning, since the node name is the first argument,
not the fourth.  Looks like a bug in makeinfo.

Andreas.
Zack Weinberg Feb. 7, 2018, 12:07 p.m. | #2
On Wed, Feb 7, 2018 at 1:50 AM, Rical Jasan <ricaljasan@pacific.net> wrote:
> A number of cross-references to the GCC info manual cause Texinfo
> warnings; e.g.:
>
>   ./creature.texi:11: warning: @xref node name should not contain `.'
>
> This is due to "gcc.info" being used in the INFO-FILE-NAME (fourth)
> argument.  Changing it to "gcc" removes these warnings.  (Manually
> confirmed equivalent behaviour for make info, html, and pdf.)
>
>         * manual/creature.texi: Convert references to gcc.info to gcc.
>         * manual/stdio.texi: Likewise.
>         * manual/string.texi: Likewise.

This is OK, please commit.

zw
Rical Jasan Feb. 9, 2018, 12:42 p.m. | #3
On 02/07/2018 04:07 AM, Zack Weinberg wrote:
> On Wed, Feb 7, 2018 at 1:50 AM, Rical Jasan <ricaljasan@pacific.net> wrote:
>> A number of cross-references to the GCC info manual cause Texinfo
>> warnings; e.g.:
>>
>>   ./creature.texi:11: warning: @xref node name should not contain `.'
>>
>> This is due to "gcc.info" being used in the INFO-FILE-NAME (fourth)
>> argument.  Changing it to "gcc" removes these warnings.  (Manually
>> confirmed equivalent behaviour for make info, html, and pdf.)
>>
>>         * manual/creature.texi: Convert references to gcc.info to gcc.
>>         * manual/stdio.texi: Likewise.
>>         * manual/string.texi: Likewise.
> 
> This is OK, please commit.

Committed; 1f6676d7da1b.

Thank you,
Rical
Rical Jasan Feb. 10, 2018, 1:28 a.m. | #4
On 02/07/2018 12:54 AM, Andreas Schwab wrote:
> On Feb 06 2018, Rical Jasan <ricaljasan@pacific.net> wrote:
> 
>> A number of cross-references to the GCC info manual cause Texinfo
>> warnings; e.g.:
>>
>>   ./creature.texi:11: warning: @xref node name should not contain `.'
> 
> This is a strange warning, since the node name is the first argument,
> not the fourth.  Looks like a bug in makeinfo.

Good eye; I've asked about this on bug-texinfo [0].

Thank you,
Rical

[0] https://lists.gnu.org/archive/html/bug-texinfo/2018-02/msg00004.html

Patch

diff --git a/manual/creature.texi b/manual/creature.texi
index 96f8ee0a0c..2e05958756 100644
--- a/manual/creature.texi
+++ b/manual/creature.texi
@@ -8,7 +8,7 @@  is controlled by which @dfn{feature test macros} you define.
 If you compile your programs using @samp{gcc -ansi}, you get only the
 @w{ISO C} library features, unless you explicitly request additional
 features by defining one or more of the feature macros.
-@xref{Invoking GCC,, GNU CC Command Options, gcc.info, The GNU CC Manual},
+@xref{Invoking GCC,, GNU CC Command Options, gcc, The GNU CC Manual},
 for more information about GCC options.@refill
 
 You should define these macros by using @samp{#define} preprocessor
diff --git a/manual/stdio.texi b/manual/stdio.texi
index 5d7b50c442..38be236991 100644
--- a/manual/stdio.texi
+++ b/manual/stdio.texi
@@ -1808,7 +1808,7 @@  verifies that the correct number and types of arguments are supplied.
 There is also a GNU C syntax to tell the compiler that a function you
 write uses a @code{printf}-style format string.
 @xref{Function Attributes, , Declaring Attributes of Functions,
-gcc.info, Using GNU CC}, for more information.
+gcc, Using GNU CC}, for more information.
 
 @node Table of Output Conversions
 @subsection Table of Output Conversions
@@ -2730,7 +2730,7 @@  This tells the compiler that @code{eprintf} uses a format string like
 the format string appears as the first argument;
 and the arguments to satisfy the format begin with the second.
 @xref{Function Attributes, , Declaring Attributes of Functions,
-gcc.info, Using GNU CC}, for more information.
+gcc, Using GNU CC}, for more information.
 
 @node Parsing a Template String
 @subsection Parsing a Template String
@@ -3478,7 +3478,7 @@  verifies that the correct number and types of arguments are supplied.
 There is also a GNU C syntax to tell the compiler that a function you
 write uses a @code{scanf}-style format string.
 @xref{Function Attributes, , Declaring Attributes of Functions,
-gcc.info, Using GNU CC}, for more information.
+gcc, Using GNU CC}, for more information.
 
 @node Table of Input Conversions
 @subsection Table of Input Conversions
@@ -4033,7 +4033,7 @@  know that a function uses a @code{scanf}-style format string.  Then it
 can check the number and types of arguments in each call to the
 function, and warn you when they do not match the format string.
 For details, see @ref{Function Attributes, , Declaring Attributes of Functions,
-gcc.info, Using GNU CC}.
+gcc, Using GNU CC}.
 
 @node EOF and Errors
 @section End-Of-File and Errors
diff --git a/manual/string.texi b/manual/string.texi
index ac02c6d85e..b07cfb4550 100644
--- a/manual/string.texi
+++ b/manual/string.texi
@@ -1087,7 +1087,7 @@  are often easier and safer automatic techniques that cause buffer
 overruns to reliably terminate a program, such as GCC's
 @option{-fcheck-pointer-bounds} and @option{-fsanitize=address}
 options.  @xref{Debugging Options,, Options for Debugging Your Program
-or GCC, gcc.info, Using GCC}.  Because truncation functions can mask
+or GCC, gcc, Using GCC}.  Because truncation functions can mask
 application bugs that would otherwise be caught by the automatic
 techniques, these functions should be used only when the application's
 underlying logic requires truncation.