[PATCH] clean up binutils documentation

Bob Wilson bwilson@tensilica.com
Wed Feb 12 21:20:00 GMT 2003


This patch fixes up a number of minor issues in the binutils documentation.  
The changelog entry is a bit terse, so here is a bit more detail on the 
changes:

* Section title capitalization: Various GNU docs handle this differently.  
Some capitalize only the first word and some capitalize all the significant 
words.  GDB seems to capitalize all the words for chapter titles but only the 
first word for section titles.  GCC mostly capitalizes all the words for both 
chapters and sections.  As far as I can tell, binutils is closest to GCC, but 
it is inconsistent.  This patch changes some of the section headings to 
capitalize all the significant words.

* The descriptions for command-line options for various binutils programs are 
not consistent with the code.  Mostly these are options in the code but 
missing from the doc.  A few options are listed incorrectly in the docs.  
I've fixed up all of these that I could find.

* The description of format options for c++filt has cut-and-paste errors 
(apparently copied from nm) and incorrectly describes these formats as being 
relevant only to C++, ignoring Java and GNAT.  It also omits the options for
Java and GNAT.

* The linker has had its own documentation for quite a while.  It seems to me 
like there's no need for the binutils documentation to continue describing 
linker emulations, etc.   The patch removes these sections.

* The bug reporting section is pretty harsh about people sending in vague bug 
reports.  The patch includes an alternate version of this text that I grabbed 
from some other GNU docs (don't remember which).  It's a bit more polite.

* The FDL appendix is mostly just plain text.  It was never properly converted 
to texinfo source.  The patch includes a new fdl.texi file that I grabbed 
from the latest GDB souces on cvs and changes binutils.texi to include it.

Here's the patch:

-------------- next part --------------
A non-text attachment was scrubbed...
Name: binutils-doc.diff
Type: text/x-diff
Size: 59435 bytes
Desc: not available
URL: <https://sourceware.org/pipermail/binutils/attachments/20030212/7732d879/attachment.bin>


More information about the Binutils mailing list