mbox series

Ping: [PATCH+wwwdocs 0/8] A small Texinfo refinement

Message ID 86cz6db60m.fsf@aarsen.me
State New
Headers show
Series Ping: [PATCH+wwwdocs 0/8] A small Texinfo refinement | expand

Pull-request

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

Message

Arsen Arsenović Feb. 13, 2023, 6:51 p.m. UTC
Ping on this patch.  I took the liberty to rebase it.  The changes are
minimal, so I didn't want to resend the entire patchset.  I included a
range diff and a pull request for your convenience.

The render is also updated, and ``make all && make html'' passes (which
is something I forgot to check last time, so tm.texi had some
complaints, apologies).

-:  ----------- > 1:  6eba1548dfe docs: Create Indices appendix
1:  3ac13e06ad7 ! 2:  3f54e2c451f docs: Reorder @opindex to be before corresponding options
    @@ gcc/doc/invoke.texi: union U @{
      
      @end itemize
      
    ++@opindex -Wno-changes-meaning
    + @item -Wno-changes-meaning @r{(C++ and Objective-C++ only)}
    + C++ requires that unqualified uses of a name within a class have the
    + same meaning in the complete scope of the class, so declaring the name
    +@@ gcc/doc/invoke.texi: error case can be reduced to a warning with
    + 
    + Both diagnostics are also suppressed by @option{-fms-extensions}.
    + 
     -@item -Wchar-subscripts
      @opindex Wchar-subscripts
      @opindex Wno-char-subscripts
    @@ gcc/doc/invoke.texi: program may yield backtraces with different addresses due t
      @opindex fsanitize=kernel-address
     +@item -fsanitize=kernel-address
      Enable AddressSanitizer for Linux kernel.
    - See @uref{https://github.com/google/kasan} for more details.
    + See @uref{https://github.com/google/kernel-sanitizers} for more details.
      
     -@item -fsanitize=hwaddress
      @opindex fsanitize=hwaddress
    @@ gcc/doc/invoke.texi: For predictable results, you must also specify the same set
      Produce a shared object which can then be linked with other objects to
      form an executable.  Not all systems support this option.  For predictable
      results, you must also specify the same set of options used for compilation
    -@@ gcc/doc/invoke.texi: to subtle defects.  Supplying them in cases where they are not necessary
    - is innocuous. For x86, crtfastmath.o will not be added when
    - @option{-shared} is specified. }
    +@@ gcc/doc/invoke.texi: is innocuous.  @option{-shared} suppresses the addition of startup code
    + to alter the floating-point environment as done with @option{-ffast-math},
    + @option{-Ofast} or @option{-funsafe-math-optimizations} on some targets.}
      
     -@item -shared-libgcc
     -@itemx -static-libgcc
2:  7ff7376a83c ! 3:  7821fcc2717 **/*.texi: Reorder index entries
    @@ Commit message
                 * doc/invoke.texi: Ditto.
                 * doc/md.texi: Ditto.
                 * doc/rtl.texi: Ditto.
    -            * doc/tm.texi: Ditto.
    +            * doc/tm.texi.in: Ditto.
                 * doc/trouble.texi: Ditto.
    +            * doc/tm.texi: Regenerate.
     
         gcc/fortran/ChangeLog:
     
    @@ gcc/doc/tm.texi: boundary, to contain the local variables of the function.  On s
      this region and the save area may occur in the opposite order, with the
      save area closer to the top of the stack.
      
    +-@item
    + @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames
    ++@item
    + Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of
    + @code{crtl->outgoing_args_size} bytes to be used for outgoing
    + argument lists of the function.  @xref{Stack Arguments}.
    +
    + ## gcc/doc/tm.texi.in ##
    +@@ gcc/doc/tm.texi.in: This section describes the macros that output function entry
    + @hook TARGET_ASM_FUNCTION_EPILOGUE
    + 
    + @itemize @bullet
    +-@item
    + @findex pretend_args_size
    + @findex crtl->args.pretend_args_size
    ++@item
    + A region of @code{crtl->args.pretend_args_size} bytes of
    + uninitialized space just underneath the first argument arriving on the
    + stack.  (This may not be at the very start of the allocated stack region
    +@@ gcc/doc/tm.texi.in: boundary, to contain the local variables of the function.  On some machines,
    + this region and the save area may occur in the opposite order, with the
    + save area closer to the top of the stack.
    + 
     -@item
      @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames
     +@item
3:  00cb8c6ad52 = 4:  af9be5e8ae7 docs: Mechanically reorder item/index combos in extend.texi
4:  af15b1b84cb ! 5:  19e506d79a4 doc: Add @defbuiltin family of helpers, set documentlanguage
    @@ gcc/doc/extend.texi: myprintf (FILE *f, const char *format, ...)
     -@end deftypefn
     +@enddefbuiltin
      
    --@deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len ()
    -+@defbuiltin{{size_t} __builtin_va_arg_pack_len ()}
    +-@deftypefn {Built-in Function} {int} __builtin_va_arg_pack_len ()
    ++@defbuiltin{int __builtin_va_arg_pack_len ()}
      This built-in function returns the number of anonymous arguments of
      an inline function.  It can be used only in inline functions that
      are always inlined, never compiled as a separate function, such
    @@ gcc/doc/extend.texi: forced to be a quiet NaN@.
     +@defbuiltin{double __builtin_nans (const char *str)}
      Similar to @code{__builtin_nan}, except the significand is forced
      to be a signaling NaN@.  The @code{nans} function is proposed by
    - @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
    + @uref{https://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
     -@end deftypefn
     +@enddefbuiltin
      
5:  76d9d48fb92 ! 6:  72e4c79fc60 Update texinfo.tex, remove the @gol macro/alias
    @@ gcc/doc/invoke.texi: This enables some extra warning flags that are not enabled
      -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}}
      
      
    -@@ gcc/doc/invoke.texi: This analysis is much more expensive than other GCC warnings.
    +@@ gcc/doc/invoke.texi: The analyzer is only suitable for use on C code in this release.
      
      Enabling this option effectively enables the following warnings:
      
6:  c68f57be956 = 7:  711d4564fc2 update_web_docs_git: Update CSS reference to new manual CSS


The following changes since commit 72ae1e5635648bd3f6a5760ca46d531ad1f2c6b1:

  tree-optimization/28614 - high FRE time for gcc.c-torture/compile/20001226-1.c (2023-02-13 15:57:09 +0100)

are available in the Git repository at:

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

for you to fetch changes up to 711d4564fc297cc1c77de2ce4c0f51cbb80ff0e4:

  update_web_docs_git: Update CSS reference to new manual CSS (2023-02-13 16:22:33 +0100)

----------------------------------------------------------------
Arsen Arsenović (7):
      docs: Create Indices appendix
      docs: Reorder @opindex to be before corresponding options
      **/*.texi: Reorder index entries
      docs: Mechanically reorder item/index combos in extend.texi
      doc: Add @defbuiltin family of helpers, set documentlanguage
      Update texinfo.tex, remove the @gol macro/alias
      update_web_docs_git: Update CSS reference to new manual CSS

 gcc/d/gdc.texi                         |  144 +-
 gcc/d/implement-d.texi                 |   66 +-
 gcc/doc/cfg.texi                       |   12 +-
 gcc/doc/cpp.texi                       |   12 +-
 gcc/doc/cppdiropts.texi                |   24 +-
 gcc/doc/cppenv.texi                    |    4 +-
 gcc/doc/cppopts.texi                   |   94 +-
 gcc/doc/cppwarnopts.texi               |   14 +-
 gcc/doc/extend.texi                    | 2564 +++++-----
 gcc/doc/gcc.texi                       |   36 +-
 gcc/doc/generic.texi                   |    2 +-
 gcc/doc/implement-c.texi               |    2 +-
 gcc/doc/include/gcc-common.texi        |   26 +-
 gcc/doc/include/texinfo.tex            | 7599 +++++++++++++++++-----------
 gcc/doc/install.texi                   |    6 +-
 gcc/doc/invoke.texi                    | 8421 ++++++++++++++++----------------
 gcc/doc/lto.texi                       |    8 +-
 gcc/doc/md.texi                        |   25 +-
 gcc/doc/rtl.texi                       |    8 +-
 gcc/doc/sourcebuild.texi               |    4 -
 gcc/doc/tm.texi                        |    4 +-
 gcc/doc/tm.texi.in                     |    4 +-
 gcc/doc/trouble.texi                   |    8 +-
 gcc/fortran/intrinsic.texi             |  722 +--
 gcc/fortran/invoke.texi                |  394 +-
 gcc/go/gccgo.texi                      |   34 +-
 maintainer-scripts/update_web_docs_git |    2 +-
 27 files changed, 11007 insertions(+), 9232 deletions(-)

Have a lovely night :)