This is the mail archive of the
newlib@sourceware.org
mailing list for the newlib project.
PATCH: another minor documentation tweak
- From: Sandra Loosemore <sandra at codesourcery dot com>
- To: newlib at sourceware dot org
- Date: Thu, 28 Aug 2008 14:32:10 -0400
- Subject: PATCH: another minor documentation tweak
The libm manual was calling its index node "Index". If you do makeinfo --html,
that creates a file named "Index.html". But, makeinfo --html also generates a
file named index.html for the main table of contents. This is OK on Linux-type
hosts, but if you install the documentation on a Windows host, where filenames
are not case-sensitive, you lose. The libc manual already calls its index node
"Library Index", which avoids the collision; so this patch makes the libm manual
use the same name.
The libc manual has a related problem, though, which I haven't tried to fix:
the auto-generated documentation for the "index" function is in a node named
"index", so it also collides with the table-of-contents index.html. In this
case, makeinfo can detect the collision, though, and the documented behavior of
makeinfo in such cases is to put both the table of contents and the contents of
the node named index in the same file named index.html. It's kind of ugly, but
it's not actually losing information, so I let it go for now. I considered
re-working makedoc to uniformly rename all the nodes from "foo" to "foo
function" to avoid this, but decided that would be spreading ugliness all over.
Hopefully someday makeinfo will be fixed to permit some alternate file-naming
strategy so you can specify how collisions are to be resolved.
-Sandra
2008-08-28 Sandra Loosemore <sandra@codesourcery.com>
newlib/
* libm/libm.texinfo (Library Index): Renamed from "Index" to prevent
conflict with index.html on case-insensitive file systems.
Index: newlib/libm/libm.texinfo
===================================================================
*** newlib/libm/libm.texinfo (revision 219233)
--- newlib/libm/libm.texinfo (working copy)
*************** into another language, under the above c
*** 94,100 ****
@menu
* Math:: The mathematical functions (`math.h').
* Reentrancy:: The functions in libm are not reentrant by default.
! * Index::
@end menu
@include targetdep.tex
--- 94,100 ----
@menu
* Math:: The mathematical functions (`math.h').
* Reentrancy:: The functions in libm are not reentrant by default.
! * Library Index::
@end menu
@include targetdep.tex
*************** In normal debugged programs, there are u
*** 123,130 ****
errors---and therefore no assignments to @code{errno} and no @code{matherr}
calls; in that situation, the math functions behave reentrantly.
! @node Index
! @unnumbered Index
@printindex cp
@tex
--- 123,130 ----
errors---and therefore no assignments to @code{errno} and no @code{matherr}
calls; in that situation, the math functions behave reentrantly.
! @node Library Index
! @unnumbered Library Index
@printindex cp
@tex