[PATCH] manual: Remove '.info' suffix in manual names passed to @ref [BZ #32962].

Sam James sam@gentoo.org
Thu Jul 3 04:17:14 GMT 2025


Collin Funk <collin.funk1@gmail.com> writes:

> Collin Funk <collin.funk1@gmail.com> writes:
>
>> Texinfo 7.2 began warning about the '.info' suffix in the manual names
>> passed to @ref and similar commands.  They eventually plan to stop
>> stripping the '.info' suffix internally which will lead to broken links
>> in the manuals without this change.

For cases like this, I like to include a short snippet of the warning in
the commit message. You don't need to do it here, but it makes it easier
to validate and also helps people searching for that warning to
understand how other projects fixed it.

For completeness, it's from texinfo's:

commit 538674a219947d16fbbb3a82d955c8d66a3eff3d
Author:     Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Dec 21 20:00:47 2024 +0100
Commit:     Patrice Dumas <pertusus@free.fr>
CommitDate: Tue Dec 24 00:55:03 2024 +0100

    * tp/texi2any.pl: remove end of line in translated string.

    * tp/Texinfo/XS/teximakehtml.c (document_warn, main): free strings
    and wipe values in the end.

    * tp/Texinfo/XS/teximakehtml.c (main): warn if input file ends with
    .info.  Complete suffixes.  Set format if TEXI2HTML is specified.

>>
>> Signed-off-by: Collin Funk <collin.funk1@gmail.com>

Reviewed-by: Sam James <sam@gentoo.org>

>> ---
>>  manual/intro.texi | 3 +--
>>  manual/maint.texi | 4 ++--
>>  manual/stdio.texi | 4 ++--
>>  3 files changed, 5 insertions(+), 6 deletions(-)
>>
>> diff --git a/manual/intro.texi b/manual/intro.texi
>> index d95648468d..3a45a51093 100644
>> --- a/manual/intro.texi
>> +++ b/manual/intro.texi
>> @@ -1061,8 +1061,7 @@ @node Header Files, Macro Definitions,  , Using the Library
>>  feature test macro definition (@pxref{Feature Test Macros}).
>>  
>>  For more information about the use of header files and @samp{#include}
>> -directives, @pxref{Header Files,,, cpp.info, The GNU C Preprocessor
>> -Manual}.
>> +directives, @pxref{Header Files,,, cpp, The GNU C Preprocessor Manual}.
>>  
>>  @Theglibc{} provides several header files, each of which contains
>>  the type and macro definitions and variable and function declarations
>> diff --git a/manual/maint.texi b/manual/maint.texi
>> index b6ee5b6e3b..3f92c88caf 100644
>> --- a/manual/maint.texi
>> +++ b/manual/maint.texi
>> @@ -725,8 +725,8 @@ @node Porting
>>  @item configure.ac
>>  
>>  This file is an Autoconf input fragment to be processed into the file
>> -@file{configure} in this subdirectory.  @xref{Introduction,,,
>> -autoconf.info, Autoconf: Generating Automatic Configuration Scripts},
>> +@file{configure} in this subdirectory.  @xref{Introduction,,, autoconf,
>> +Autoconf: Generating Automatic Configuration Scripts},
>>  for a description of Autoconf.  You should write either @file{configure}
>>  or @file{configure.ac}, but not both.  The first line of
>>  @file{configure.ac} should invoke the @code{m4} macro
>> diff --git a/manual/stdio.texi b/manual/stdio.texi
>> index 29ed720839..16d459424e 100644
>> --- a/manual/stdio.texi
>> +++ b/manual/stdio.texi
>> @@ -3518,8 +3518,8 @@ @node Formatted Input Basics
>>  pattern, you may be better off using a tool such as Flex to generate a
>>  lexical scanner, or Bison to generate a parser, rather than using
>>  @code{scanf}.  For more information about these tools, see @ref{Top, , ,
>> -flex.info, Flex: The Lexical Scanner Generator}, and @ref{Top, , ,
>> -bison.info, The Bison Reference Manual}.
>> +flex, Flex: The Lexical Scanner Generator}, and @ref{Top, , , bison, The
>> +Bison Reference Manual}.
>>  
>>  @node Input Conversion Syntax
>>  @subsection Input Conversion Syntax
>
> Could someone please check this patch?
>
> It seems obvious, since it will keep the manual from breaking with
> future Texinfo releases.

Done. Thanks.

>
> Thanks,
> Collin

sam


More information about the Libc-alpha mailing list