public inbox for binutils@sourceware.org
 help / color / mirror / Atom feed
From: Carlos O'Donell <carlos@codesourcery.com>
To: binutils@sourceware.org
Subject: [PATCH] Fix html filenames on case insensitive filesystems.
Date: Thu, 11 May 2006 20:57:00 -0000	[thread overview]
Message-ID: <20060511154503.GC21801@lios> (raw)


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
 

             reply	other threads:[~2006-05-11 15:46 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-05-11 20:57 Carlos O'Donell [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20060511154503.GC21801@lios \
    --to=carlos@codesourcery.com \
    --cc=binutils@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).