* [PATCH] Fix html filenames on case insensitive filesystems.
@ 2006-05-11 20:57 Carlos O'Donell
2006-05-11 21:24 ` Nick Clifton
2006-05-15 11:12 ` Ben Elliston
0 siblings, 2 replies; 6+ messages in thread
From: Carlos O'Donell @ 2006-05-11 20:57 UTC (permalink / raw)
To: binutils
In a case insensitive filesystem, the file "index.html" and "Index.html"
are the same file, similarly "abort.html" and "ABORT.html" are the same
file.
The binutils html manuals are built using "makeinfo --html", which
converts @node names directly into <node>.html when splitting the html
files. In a case insensitive filesystem this causes certains files to
conflict.
As a solution to the conflict, I would like to suggest a very small
modification to the manuals for bfd, ld, and gas. Perhaps in the future
makeinfo can be taught a clever trick.
Tested on i686-pc-linux-gnu, builds, produces html/info/man pages
correctly. I gave a quick glance through all the generated documentation
output and it looks to be correct.
Ok to commit?
Cheers,
Carlos.
--
Carlos O'Donell
CodeSourcery
carlos@codesourcery.com
(650) 331-3385 x716
2006-05-11 Carlos O'Donell <carlos@codesourcery.com>
* bfd/doc/bfd.texinfo: Rename "Index" to "BFD Index"
* ld/ld.texinfo: Rename "Index" to "LD Index"
* gas/doc/as.texinfo: Rename "Index" to "AS Index",
and "ABORT" to "ABORT (COFF)"
Index: bfd/doc/bfd.texinfo
===================================================================
RCS file: /cvs/src/src/bfd/doc/bfd.texinfo,v
retrieving revision 1.9
diff -u -p -r1.9 bfd.texinfo
--- bfd/doc/bfd.texinfo 3 Mar 2005 11:41:02 -0000 1.9
+++ bfd/doc/bfd.texinfo 11 May 2006 15:34:34 -0000
@@ -98,7 +98,7 @@ This file documents the binary file desc
* BFD front end:: BFD front end
* BFD back ends:: BFD back ends
* GNU Free Documentation License:: GNU Free Documentation License
-* Index:: Index
+* BFD Index:: BFD Index
@end menu
@node Overview, BFD front end, Top, Top
@@ -324,11 +324,11 @@ All of BFD lives in one directory.
@node mmo, , elf, BFD back ends
@include mmo.texi
-@node GNU Free Documentation License, Index, BFD back ends, Top
+@node GNU Free Documentation License, BFD Index, BFD back ends, Top
@include fdl.texi
-@node Index, , GNU Free Documentation License, Top
-@unnumbered Index
+@node BFD Index, , GNU Free Documentation License, Top
+@unnumbered BFD Index
@printindex cp
@tex
Index: gas/doc/as.texinfo
===================================================================
RCS file: /cvs/src/src/gas/doc/as.texinfo,v
retrieving revision 1.144
diff -u -p -r1.144 as.texinfo
--- gas/doc/as.texinfo 8 May 2006 15:57:05 -0000 1.144
+++ gas/doc/as.texinfo 11 May 2006 15:34:35 -0000
@@ -191,7 +191,7 @@ section entitled ``GNU Free Documentatio
* Reporting Bugs:: Reporting Bugs
* Acknowledgements:: Who Did What
* GNU Free Documentation License:: GNU Free Documentation License
-* Index:: Index
+* AS Index:: AS Index
@end menu
@end ifnottex
@@ -3736,7 +3736,7 @@ Some machine configurations provide addi
@menu
* Abort:: @code{.abort}
@ifset COFF
-* ABORT:: @code{.ABORT}
+* ABORT (COFF):: @code{.ABORT}
@end ifset
* Align:: @code{.align @var{abs-expr} , @var{abs-expr}}
@@ -3914,8 +3914,8 @@ of the source quit, it could use this di
quit also. One day @code{.abort} will not be supported.
@ifset COFF
-@node ABORT
-@section @code{.ABORT}
+@node ABORT (COFF)
+@section @code{.ABORT} (COFF)
@cindex @code{ABORT} directive
When producing COFF output, @command{@value{AS}} accepts this directive as a
@@ -6764,8 +6764,8 @@ intentionally leaving anyone out.
@include fdl.texi
-@node Index
-@unnumbered Index
+@node AS Index
+@unnumbered AS Index
@printindex cp
Index: ld/ld.texinfo
===================================================================
RCS file: /cvs/src/src/ld/ld.texinfo,v
retrieving revision 1.161
diff -u -p -r1.161 ld.texinfo
--- ld/ld.texinfo 5 May 2006 00:51:37 -0000 1.161
+++ ld/ld.texinfo 11 May 2006 15:34:36 -0000
@@ -182,7 +182,7 @@ section entitled ``GNU Free Documentatio
* Reporting Bugs:: Reporting Bugs
* MRI:: MRI Compatible Script Files
* GNU Free Documentation License:: GNU Free Documentation License
-* Index:: Index
+* LD Index:: LD Index
@end menu
@end ifnottex
@@ -6629,8 +6629,8 @@ If you have more than one @code{SECT} st
@include fdl.texi
-@node Index
-@unnumbered Index
+@node LD Index
+@unnumbered LD Index
@printindex cp
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Fix html filenames on case insensitive filesystems.
2006-05-11 20:57 [PATCH] Fix html filenames on case insensitive filesystems Carlos O'Donell
@ 2006-05-11 21:24 ` Nick Clifton
2006-05-11 21:24 ` Carlos O'Donell
2006-05-15 11:12 ` Ben Elliston
1 sibling, 1 reply; 6+ messages in thread
From: Nick Clifton @ 2006-05-11 21:24 UTC (permalink / raw)
To: Carlos O'Donell; +Cc: binutils
Hi Carlos,
> Tested on i686-pc-linux-gnu, builds, produces html/info/man pages
> correctly. I gave a quick glance through all the generated documentation
> output and it looks to be correct.
>
> Ok to commit?
Approved - please apply.
Cheers
Nick
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Fix html filenames on case insensitive filesystems.
2006-05-11 21:24 ` Nick Clifton
@ 2006-05-11 21:24 ` Carlos O'Donell
0 siblings, 0 replies; 6+ messages in thread
From: Carlos O'Donell @ 2006-05-11 21:24 UTC (permalink / raw)
To: Nick Clifton; +Cc: binutils
On Thu, May 11, 2006 at 04:52:53PM +0100, Nick Clifton wrote:
> >Tested on i686-pc-linux-gnu, builds, produces html/info/man pages
> >correctly. I gave a quick glance through all the generated documentation
> >output and it looks to be correct.
> >
> >Ok to commit?
>
> Approved - please apply.
OK, checked in with the changes moved to the
appropriate subdirectory ChangeLog's.
Cheers,
Carlos.
--
Carlos O'Donell
CodeSourcery
carlos@codesourcery.com
(650) 331-3385 x716
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Fix html filenames on case insensitive filesystems.
2006-05-11 20:57 [PATCH] Fix html filenames on case insensitive filesystems Carlos O'Donell
2006-05-11 21:24 ` Nick Clifton
@ 2006-05-15 11:12 ` Ben Elliston
2006-05-16 23:09 ` Carlos O'Donell
1 sibling, 1 reply; 6+ messages in thread
From: Ben Elliston @ 2006-05-15 11:12 UTC (permalink / raw)
To: Carlos O'Donell; +Cc: binutils
> The binutils html manuals are built using "makeinfo --html", which
> converts @node names directly into <node>.html when splitting the
> html files. In a case insensitive filesystem this causes certains
> files to conflict.
Perhaps you should report this problem to the Texinfo maintainer, too?
At the very least, makeinfo could complain about this condition. A
better alternative might be to mangle the output filenames a bit so
that the user need not be concerned with this.
Ben
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Fix html filenames on case insensitive filesystems.
2006-05-15 11:12 ` Ben Elliston
@ 2006-05-16 23:09 ` Carlos O'Donell
2006-05-17 20:37 ` Nick Clifton
0 siblings, 1 reply; 6+ messages in thread
From: Carlos O'Donell @ 2006-05-16 23:09 UTC (permalink / raw)
To: Ben Elliston; +Cc: binutils, Nick Clifton
On Mon, May 15, 2006 at 12:11:15PM +1000, Ben Elliston wrote:
> > The binutils html manuals are built using "makeinfo --html", which
> > converts @node names directly into <node>.html when splitting the
> > html files. In a case insensitive filesystem this causes certains
> > files to conflict.
>
> Perhaps you should report this problem to the Texinfo maintainer, too?
> At the very least, makeinfo could complain about this condition. A
> better alternative might be to mangle the output filenames a bit so
> that the user need not be concerned with this.
Issue sent to bug-texinfo@ggnu.org.
Nick, I missed a manul in my first sweep. It's interesting that
"Index.html" is a pretty passable "index.html" for all the manuals :)
Builds without regressions on i686-pc-linux-gnu.
OK to commit?
Cheers,
Carlos.
--
Carlos O'Donell
CodeSourcery
carlos@codesourcery.com
(650) 331-3385 x716
2006-05-16 Carlos O'Donell <carlos@codesourcery.com>
* doc/binutils.texi: Use "Binutils Index" for index name.
Index: doc/binutils.texi
===================================================================
RCS file: /cvs/src/src/binutils/doc/binutils.texi,v
retrieving revision 1.91
diff -u -p -r1.91 binutils.texi
--- doc/binutils.texi 2 May 2006 14:20:46 -0000 1.91
+++ doc/binutils.texi 16 May 2006 20:02:25 -0000
@@ -172,7 +172,7 @@ section entitled "GNU Free Documentation
* Selecting The Target System:: How these utilities determine the target.
* Reporting Bugs:: Reporting Bugs
* GNU Free Documentation License:: GNU Free Documentation License
-* Index:: Index
+* Binutils Index:: Binutils Index
@end menu
@node ar
@@ -3898,8 +3898,8 @@ things without first using the debugger
@include fdl.texi
-@node Index
-@unnumbered Index
+@node Binutils Index
+@unnumbered Binutils Index
@printindex cp
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Fix html filenames on case insensitive filesystems.
2006-05-16 23:09 ` Carlos O'Donell
@ 2006-05-17 20:37 ` Nick Clifton
0 siblings, 0 replies; 6+ messages in thread
From: Nick Clifton @ 2006-05-17 20:37 UTC (permalink / raw)
To: Carlos O'Donell; +Cc: Ben Elliston, binutils
Hi Carlos,
> OK to commit?
> 2006-05-16 Carlos O'Donell <carlos@codesourcery.com>
>
> * doc/binutils.texi: Use "Binutils Index" for index name.
Approved - please apply.
Cheers
Nick
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2006-05-17 15:32 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2006-05-11 20:57 [PATCH] Fix html filenames on case insensitive filesystems Carlos O'Donell
2006-05-11 21:24 ` Nick Clifton
2006-05-11 21:24 ` Carlos O'Donell
2006-05-15 11:12 ` Ben Elliston
2006-05-16 23:09 ` Carlos O'Donell
2006-05-17 20:37 ` Nick Clifton
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).