Re: [PATCH v2 4/5] Update texinfo.tex, remove the @gol macro/alias

["Arsen Arsenović" <arsen@aarsen.me>]

[-- Attachment #1: Type: text/plain, Size: 6555 bytes --]

Afternoon,

Sandra Loosemore <sandra@codesourcery.com> writes:

> On 2/23/23 03:27, Arsen Arsenović via Gcc-patches wrote:
>> The @gol macro appears to have existed as a workaround for a bug in old
>> versions of makeinfo and/or texinfo.tex, where they would, in some types
>> of output, fail to emit line breaks in @gccoptlists.  After updating
>> texinfo.tex, I noticed that this behavior appears to no longer be
>> exhibited, instead, both acted correctly and inserted newlines.  The
>> (groff) manual output also appears unaffected.
>> gcc/ChangeLog:
>> 	* doc/include/texinfo.tex: Update to 2023-01-17.19.
>> 	* doc/implement-c.texi: Remove usage of @gol.
>> 	* doc/invoke.texi: Ditto.
>> 	* doc/sourcebuild.texi: Ditto.
>> 	* doc/include/gcc-common.texi: Remove @gol.  In new Makeinfo and
>> 	texinfo.tex versions, the bug it was working around appears to
>> 	be gone.
>> gcc/fortran/ChangeLog:
>> 	* invoke.texi: Remove usages of @gol.
>> 	* intrinsic.texi: Ditto.
>
> This is OK, but I'd like to see this patch split into two separate commits as
> well -- one for the texinfo.tex import, and one for the @gol changes.

The full log is below.  This branch is also, as usual, visible on my
fork at:

  https://git.sr.ht/~arsen/gcc texinfo_improvements

... and is visible in web form at:

  https://git.sr.ht/~arsen/gcc/log/texinfo_improvements

I rebased the patchset to today's revision again.

The log:

commit 63fcce9b7d7af55fd73024fa42cb44fde9063c3a
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Thu Mar 9 21:44:29 2023 +0100

    update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline
    
    maintainer-scripts/ChangeLog:
    
            * update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline in
            order to put @shortcontents above contents. See
            9dd976a4-4e09-d901-b949-6d5037567b9b@codesourcery.com on
            gcc-patches.

commit 04c696ed31e623d003a0472f83d6a93c53541790
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Tue Feb 28 11:40:56 2023 +0100

    docs: Fix up new instances of index reordering
    
    This commit fixes up an instance of the index entry mis-ordering that
    occurred between the formulation and application of commit
    r13-6310-gf33d7a88d069d1.
    
    gcc/ChangeLog:
    
            * doc/extend.texi: Associate use_hazard_barrier_return index
            entry with its attribute.
            * doc/invoke.texi: Associate -fcanon-prefix-map index entry with
            its attribute

commit cfc401f06bf46fd98ee1272e0204155d635b3c42
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Thu Jan 26 18:50:38 2023 +0100

    update_web_docs_git: Update CSS reference to new manual CSS
    
    maintainer-scripts/ChangeLog:
    
            * update_web_docs_git (CSS): Update CSS reference to point to
            /texinfo-manuals.css.

commit d3c953045f99523a726d1d2b2d25bc9e9352fdfd
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Wed Jan 25 23:33:03 2023 +0100

    doc: Remove the @gol macro/alias
    
    The @gol macro appears to have existed as a workaround for a bug in old
    versions of makeinfo and/or texinfo.tex, where they would, in some types
    of output, fail to emit line breaks in @gccoptlists.  After updating
    texinfo.tex, I noticed that this behavior appears to no longer be
    exhibited, instead, both acted correctly and inserted newlines.  The
    (groff) manual output also appears unaffected.
    
    gcc/ChangeLog:
    
            * doc/implement-c.texi: Remove usage of @gol.
            * doc/invoke.texi: Ditto.
            * doc/sourcebuild.texi: Ditto.
            * doc/include/gcc-common.texi: Remove @gol.  In new Makeinfo and
            texinfo.tex versions, the bug it was working around appears to
            be gone.
    
    gcc/fortran/ChangeLog:
    
            * invoke.texi: Remove usages of @gol.
            * intrinsic.texi: Ditto.

commit e543f4acda2573331d02a99a779f8710abfb14c6
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Fri Mar 10 16:21:33 2023 +0100

    doc: Update texinfo.tex
    
    gcc/ChangeLog:
    
            * doc/include/texinfo.tex: Update to 2023-01-17.19.

commit 5f093996a453656755a0209271d01392d05b849e
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Fri Mar 10 16:13:28 2023 +0100

    docs: Add @defbuiltin family of helpers
    
    The @defbuiltin{,x} macros are convenience macros for the often-repeated
    task of defining a built-in function in extend.texi.  Usage of this
    macro should lead to a higher degree of consistency across pieces of
    text written by different people, and provide a better reading
    experience, as they prevent easy-to-make errors, like forgetting index
    entries for these functions.
    
    gcc/ChangeLog:
    
            * doc/include/gcc-common.texi: Add @defbuiltin{,x} and
            @enddefbuiltin for defining built-in functions.
            * doc/extend.texi: Apply @defbuiltin{,x} to many, but not all,
            places where it should be used.

commit a867275185f2f2d5d654394a406ae28f16a4f26a
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Fri Mar 10 16:08:19 2023 +0100

    doc: Fix a few minor errors spotted by testers
    
    This commit addresses a few minor errors that were spotted while testing
    the GCC manual with a few people, and while working on wider changes.
    
    gcc/ChangeLog:
    
            * doc/extend.texi (Formatted Output Function Checking): New
            subsection for  grouping together printf et al.
            (Exception handling) Fix missing @ sign before copyright
            header, which lead to the copyright line leaking into
            '(gcc)Exception handling'.
            * doc/gcc.texi: Set document language to en_US.
            (@copying): Wrap front cover texts in quotations, move in manual
            description text.

commit 8e0739647b9fe429b57c7855b2ed0dee00407457
Author: Arsen Arsenović <arsen@aarsen.me>
Date:   Sun Nov 20 17:57:46 2022 +0100

    docs: Create Indices appendix
    
    The GCC manual has multiple indices.  By creating an appendix which
    lists them, we help makeinfo present a more accessible way for the
    reader to see all the indices.
    
    gcc/ChangeLog:
    
            * doc/gcc.texi: Add the Indices appendix, to make texinfo
            generate nice indices overview page.

> -Sandra

Have a lovely day.
-- 
Arsen Arsenović

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 251 bytes --]