public inbox for newlib@sourceware.org
 help / color / mirror / Atom feed
* [PATCH] newlib: docs: print the function index
@ 2024-01-05  5:00 Mike Frysinger
  2024-01-05  5:09 ` [PATCH v2] " Mike Frysinger
  0 siblings, 1 reply; 2+ messages in thread
From: Mike Frysinger @ 2024-01-05  5:00 UTC (permalink / raw)
  To: newlib

The generated function documentation makes sure to include entries for
every function in the function index via @findex, but then the manuals
forget to actually print the index.
---
 newlib/libc/libc.texi | 4 ++++
 newlib/libm/libm.texi | 5 +++++
 2 files changed, 9 insertions(+)

diff --git a/newlib/libc/libc.texi b/newlib/libc/libc.texi
index c6aeab2278f1..ea96f86b6e3f 100644
--- a/newlib/libc/libc.texi
+++ b/newlib/libc/libc.texi
@@ -410,6 +410,10 @@ usage as the ANSI C version from @file{stdarg.h}.
 @unnumbered Document Index
 @printindex cp
 
+@node Function Index
+@unnumbered Function Index
+@printindex fn
+
 @tex
 % I think something like @@colophon should be in texinfo.  In the
 % meantime:
diff --git a/newlib/libm/libm.texi b/newlib/libm/libm.texi
index 943262d055ae..26c393df8c6b 100644
--- a/newlib/libm/libm.texi
+++ b/newlib/libm/libm.texi
@@ -121,10 +121,15 @@ This makes it thread safe, and therefore reentrant.
 Currently, the full set of long double math functions is only provided
 on platforms where long double equals double.
 For such platforms, the long double math functions are implemented as calls to the double versions.
+
 @node Document Index
 @unnumbered Document Index
 @printindex cp
 
+@node Function Index
+@unnumbered Function Index
+@printindex fn
+
 @tex
 % I think something like @@colophon should be in texinfo.  In the
 % meantime:
-- 
2.43.0


^ permalink raw reply	[flat|nested] 2+ messages in thread

* [PATCH v2] newlib: docs: print the function index
  2024-01-05  5:00 [PATCH] newlib: docs: print the function index Mike Frysinger
@ 2024-01-05  5:09 ` Mike Frysinger
  0 siblings, 0 replies; 2+ messages in thread
From: Mike Frysinger @ 2024-01-05  5:09 UTC (permalink / raw)
  To: newlib

The generated function documentation makes sure to include entries for
every function in the function index via @findex, but then the manuals
forget to actually print the index.
---
v2
- forgot to update @menu entries for info pages

 newlib/libc/libc.texi | 5 +++++
 newlib/libm/libm.texi | 6 ++++++
 2 files changed, 11 insertions(+)

diff --git a/newlib/libc/libc.texi b/newlib/libc/libc.texi
index c6aeab2278f1..a642f424bbad 100644
--- a/newlib/libc/libc.texi
+++ b/newlib/libc/libc.texi
@@ -155,6 +155,7 @@ into another language, under the above conditions for modified versions.
 * Overflow Protection::
 
 * Document Index::
+* Function Index::
 @end menu
 @end ifnottex
 
@@ -410,6 +411,10 @@ usage as the ANSI C version from @file{stdarg.h}.
 @unnumbered Document Index
 @printindex cp
 
+@node Function Index
+@unnumbered Function Index
+@printindex fn
+
 @tex
 % I think something like @@colophon should be in texinfo.  In the
 % meantime:
diff --git a/newlib/libm/libm.texi b/newlib/libm/libm.texi
index 943262d055ae..d322422c2cde 100644
--- a/newlib/libm/libm.texi
+++ b/newlib/libm/libm.texi
@@ -98,6 +98,7 @@ into another language, under the above conditions for modified versions.
 * Reentrancy::     The functions in libm are not reentrant by default.
 * Long Double Functions:: The long double function support of libm.
 * Document Index::
+* Function Index::
 @end menu
 
 @include targetdep.tex
@@ -121,10 +122,15 @@ This makes it thread safe, and therefore reentrant.
 Currently, the full set of long double math functions is only provided
 on platforms where long double equals double.
 For such platforms, the long double math functions are implemented as calls to the double versions.
+
 @node Document Index
 @unnumbered Document Index
 @printindex cp
 
+@node Function Index
+@unnumbered Function Index
+@printindex fn
+
 @tex
 % I think something like @@colophon should be in texinfo.  In the
 % meantime:
-- 
2.43.0


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2024-01-05  5:09 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-01-05  5:00 [PATCH] newlib: docs: print the function index Mike Frysinger
2024-01-05  5:09 ` [PATCH v2] " Mike Frysinger

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).