From: Bruno Haible Date: Mon, 30 Dec 2024 14:38:51 +0000 (+0100) Subject: doc: Revisit some index entries. X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=c08abe38ebc2cfd8e0901230f48374d632e95868;p=gnulib.git doc: Revisit some index entries. * doc/attribute.texi: Refer to the 'attribute' module. * doc/verify.texi: Refer to the 'verify' module. * doc/noreturn.texi: Remove duplicate index entries. --- diff --git a/ChangeLog b/ChangeLog index bacd26e18f..eb0b79996a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2024-12-30 Bruno Haible + + doc: Revisit some index entries. + * doc/attribute.texi: Refer to the 'attribute' module. + * doc/verify.texi: Refer to the 'verify' module. + * doc/noreturn.texi: Remove duplicate index entries. + 2024-12-30 Bruno Haible doc: Document the 'inline' module. diff --git a/doc/attribute.texi b/doc/attribute.texi index 8895eb3a4e..fb6ae59ff1 100644 --- a/doc/attribute.texi +++ b/doc/attribute.texi @@ -13,9 +13,9 @@ @cindex Attributes @findex __attribute__ - -This module provides a header file @file{attribute.h} that defines -macros related to C and C++ attributes and the GCC +@mindex attribute +The module @samp{attribute} provides a header file @file{attribute.h} that +defines macros related to C and C++ attributes and the GCC @code{__attribute__} keyword. Here is an example of its use: diff --git a/doc/noreturn.texi b/doc/noreturn.texi index 06bc791621..659eef8acb 100644 --- a/doc/noreturn.texi +++ b/doc/noreturn.texi @@ -1,4 +1,4 @@ -@c GNU noreturn, stdnoreturn modules documentation +@c GNU noreturn, stdnoreturn-h modules documentation @c Copyright (C) 2019--2024 Free Software Foundation, Inc. @@ -11,9 +11,6 @@ @node Non-returning Functions @section Non-returning Functions -@cindex @code{_Noreturn} -@mindex @code{noreturn} -@mindex @code{stdnoreturn-h} A "non-returning" function is a function which cannot return normally. Instead of returning, it can loop forever, or it can transfer control via @code{abort}, @code{execvp}, @code{exit}, @code{longjmp}, @code{throw} @@ -29,6 +26,7 @@ Gnulib has multiple ways to support such a declaration: @itemize @bullet @item +@cindex @code{_Noreturn} The @code{_Noreturn} keyword. No modules are needed, as Gnulib arranges for @code{} to define @code{_Noreturn} to an appropriate replacement on platforms lacking it. diff --git a/doc/verify.texi b/doc/verify.texi index 40fc459972..99b9e37fa8 100644 --- a/doc/verify.texi +++ b/doc/verify.texi @@ -14,8 +14,8 @@ @cindex assertion @findex verify @findex verify_expr - -This module provides a header file @file{verify.h} that defines +@mindex verify +The module @samp{verify} provides a header file @file{verify.h} that defines macros related to compile-time verification. Two of these macros are @code{verify (@var{V})} and @code{verify_expr