PATCH: another minor documentation tweak

Sandra Loosemore sandra@codesourcery.com
Mon Sep 1 11:14:00 GMT 2008


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

-------------- next part --------------
A non-text attachment was scrubbed...
Name: newlib2.log
Type: text/x-log
Size: 196 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/newlib/attachments/20080901/65d9e34a/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: newlib2.patch
Type: text/x-patch
Size: 1199 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/newlib/attachments/20080901/65d9e34a/attachment-0001.bin>


More information about the Newlib mailing list