This is the mail archive of the
binutils@sourceware.org
mailing list for the binutils project.
PATCH: Final documentation changes for @file
- From: Mark Mitchell <mark at codesourcery dot com>
- To: binutils at sources dot redhat dot com
- Date: Wed, 16 Nov 2005 11:00:31 -0800
- Subject: PATCH: Final documentation changes for @file
- Reply-to: mark at codesourcery dot com
I believe that this patch will (finally) wrap up the "@file" support.
This patch, following the same approach used for the GAS
documentation, adds "@file" to the manuals for binutils, gprof, and
ld. I tested the patch by looking at the generated documentation in
both info format and manual-page format.
OK?
--
Mark Mitchell
CodeSourcery, LLC
mark@codesourcery.com
2005-11-16 Mark Mitchell <mark@codesourcery.com>
* doc/binutils.texi: Include config.texi and @file documentation
for manual pages.
2005-11-16 Mark Mitchell <mark@codesourcery.com>
* Makefile.am (gprof.info, gprof.1): Depend on config.texi.
(config.texi): New file.
* Makefile.in: Regenerated.
2005-11-16 Mark Mitchell <mark@codesourcery.com>
* Makefile.am (configdoc.texi): Set top_srcdir in configdoc.texi..
* Makefile.in: Regenerated.
* ld.texinfo: Include configdoc.texi and ldver.texi in man pages.
Add @file documentation.
Index: binutils/doc/binutils.texi
===================================================================
RCS file: /cvs/src/src/binutils/doc/binutils.texi,v
retrieving revision 1.85
diff -c -5 -p -r1.85 binutils.texi
*** binutils/doc/binutils.texi 15 Nov 2005 08:33:38 -0000 1.85
--- binutils/doc/binutils.texi 16 Nov 2005 18:40:56 -0000
***************
*** 1,10 ****
--- 1,12 ----
\input texinfo @c -*- Texinfo -*-
@setfilename binutils.info
@c Copyright 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+ @c man begin INCLUDE
@include config.texi
+ @c man end
@ifinfo
@format
START-INFO-DIR-ENTRY
* Binutils: (binutils). The GNU binary utilities.
*************** objdump(1), and the Info entries for @fi
*** 3503,3522 ****
--- 3505,3528 ----
@chapter Common Options
The following command-line options are supported by all of the
programs described in this manual.
+ @c man begin OPTIONS
@table @env
@include @value{top_srcdir}/../libiberty/at-file.texi
+ @c man end
@item --help
Display the command-line options supported by the program.
@item --version
Display the version number of the program.
+ @c man begin OPTIONS
@end table
+ @c man end
@node Selecting The Target System
@chapter Selecting the Target System
You can specify two aspects of the target system to the @sc{gnu}
Index: gprof/Makefile.am
===================================================================
RCS file: /cvs/src/src/gprof/Makefile.am,v
retrieving revision 1.23
diff -c -5 -p -r1.23 Makefile.am
*** gprof/Makefile.am 14 Apr 2005 05:26:37 -0000 1.23
--- gprof/Makefile.am 16 Nov 2005 18:40:56 -0000
*************** TEXI2POD = perl $(srcdir)/../etc/texi2po
*** 56,69 ****
POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1
info_TEXINFOS = gprof.texi
man_MANS = gprof.1
# Build the man page from the texinfo file
# The sed command removes the no-adjust Nroff command so that
# the man output looks standard.
! gprof.1: $(srcdir)/gprof.texi
touch $@
-$(TEXI2POD) $(MANCONF) -Dgprof < $(srcdir)/gprof.texi > gprof.pod
-($(POD2MAN) gprof.pod | \
sed -e '/^.if n .na/d' > $@.T$$$$ && \
mv -f $@.T$$$$ $@) || \
--- 56,74 ----
POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1
info_TEXINFOS = gprof.texi
man_MANS = gprof.1
+ $(srcdir)/gprof.info: gprof.texi config.texi
+
+ config.texi:
+ echo "@set top_srcdir $(top_srcdir)" >> ./config.texi
+
# Build the man page from the texinfo file
# The sed command removes the no-adjust Nroff command so that
# the man output looks standard.
! gprof.1: $(srcdir)/gprof.texi config.texi
touch $@
-$(TEXI2POD) $(MANCONF) -Dgprof < $(srcdir)/gprof.texi > gprof.pod
-($(POD2MAN) gprof.pod | \
sed -e '/^.if n .na/d' > $@.T$$$$ && \
mv -f $@.T$$$$ $@) || \
Index: gprof/Makefile.in
===================================================================
RCS file: /cvs/src/src/gprof/Makefile.in,v
retrieving revision 1.32
diff -c -5 -p -r1.32 Makefile.in
*** gprof/Makefile.in 14 Apr 2005 05:26:37 -0000 1.32
--- gprof/Makefile.in 16 Nov 2005 18:40:56 -0000
*************** distclean-libtool:
*** 405,415 ****
else \
if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \
rm -rf $(@:.html=); else rm -Rf $(@:.html=.htp) $@; fi; \
exit 1; \
fi
- $(srcdir)/gprof.info: gprof.texi
gprof.dvi: gprof.texi
gprof.pdf: gprof.texi
gprof.html: gprof.texi
.dvi.ps:
$(DVIPS) -o $@ $<
--- 405,414 ----
*************** diststuff: $(BUILT_SOURCES) info $(man_M
*** 781,794 ****
FILE=$*.m $(srcdir)/$*.m
po/POTFILES.in: @MAINT@ Makefile
for f in $(POTFILES); do echo $$f; done | LC_COLLATE= sort > tmp \
&& mv tmp $(srcdir)/po/POTFILES.in
# Build the man page from the texinfo file
# The sed command removes the no-adjust Nroff command so that
# the man output looks standard.
! gprof.1: $(srcdir)/gprof.texi
touch $@
-$(TEXI2POD) $(MANCONF) -Dgprof < $(srcdir)/gprof.texi > gprof.pod
-($(POD2MAN) gprof.pod | \
sed -e '/^.if n .na/d' > $@.T$$$$ && \
mv -f $@.T$$$$ $@) || \
--- 780,798 ----
FILE=$*.m $(srcdir)/$*.m
po/POTFILES.in: @MAINT@ Makefile
for f in $(POTFILES); do echo $$f; done | LC_COLLATE= sort > tmp \
&& mv tmp $(srcdir)/po/POTFILES.in
+ $(srcdir)/gprof.info: gprof.texi config.texi
+
+ config.texi:
+ echo "@set top_srcdir $(top_srcdir)" >> ./config.texi
+
# Build the man page from the texinfo file
# The sed command removes the no-adjust Nroff command so that
# the man output looks standard.
! gprof.1: $(srcdir)/gprof.texi config.texi
touch $@
-$(TEXI2POD) $(MANCONF) -Dgprof < $(srcdir)/gprof.texi > gprof.pod
-($(POD2MAN) gprof.pod | \
sed -e '/^.if n .na/d' > $@.T$$$$ && \
mv -f $@.T$$$$ $@) || \
Index: gprof/gprof.texi
===================================================================
RCS file: /cvs/src/src/gprof/gprof.texi,v
retrieving revision 1.17
diff -c -5 -p -r1.17 gprof.texi
*** gprof/gprof.texi 9 May 2005 06:55:25 -0000 1.17
--- gprof/gprof.texi 16 Nov 2005 18:40:56 -0000
***************
*** 3,12 ****
--- 3,16 ----
@c Copyright 1988, 1992, 1993, 1998, 1999, 2000, 2001, 2002, 2003, 2004
@c Free Software Foundation, Inc.
@settitle GNU gprof
@setchapternewpage odd
+ @c man begin INCLUDE
+ @include config.texi
+ @c man end
+
@ifinfo
@c This is a dir.info fragment to support semi-automated addition of
@c manuals to an info tree. zoo@cygnus.com is developing this facility.
@format
START-INFO-DIR-ENTRY
*************** gprof [ -[abcDhilLrsTvwxyz] ] [ -[ACeEfF
*** 118,128 ****
[ --file-info ] [ --help ] [ --line ] [ --min-count=@var{n} ]
[ --no-static ] [ --print-path ] [ --separate-files ]
[ --static-call-graph ] [ --sum ] [ --table-length=@var{len} ]
[ --traditional ] [ --version ] [ --width=@var{n} ]
[ --ignore-non-functions ] [ --demangle[=@var{STYLE}] ]
! [ --no-demangle ] [ @var{image-file} ] [ @var{profile-file} @dots{} ]
@c man end
@end smallexample
@c man begin DESCRIPTION
@code{gprof} produces an execution profile of C, Pascal, or Fortran77
--- 122,133 ----
[ --file-info ] [ --help ] [ --line ] [ --min-count=@var{n} ]
[ --no-static ] [ --print-path ] [ --separate-files ]
[ --static-call-graph ] [ --sum ] [ --table-length=@var{len} ]
[ --traditional ] [ --version ] [ --width=@var{n} ]
[ --ignore-non-functions ] [ --demangle[=@var{STYLE}] ]
! [ --no-demangle ] [ @@@var{file} ] [ @var{image-file} ]
! [ @var{profile-file} @dots{} ]
@c man end
@end smallexample
@c man begin DESCRIPTION
@code{gprof} produces an execution profile of C, Pascal, or Fortran77
*************** that had no time spent in them. This is
*** 726,735 ****
--- 731,742 ----
@node Miscellaneous Options,Deprecated Options,Analysis Options,Invoking
@section Miscellaneous Options
@table @code
+ @include @value{top_srcdir}/../libiberty/at-file.texi
+
@item -d[@var{num}]
@itemx --debug[=@var{num}]
The @samp{-d @var{num}} option specifies debugging options.
If @var{num} is not specified, enable all debugging.
@xref{Debugging}.
Index: ld/Makefile.am
===================================================================
RCS file: /cvs/src/src/ld/Makefile.am,v
retrieving revision 1.194
diff -c -5 -p -r1.194 Makefile.am
*** ld/Makefile.am 30 Oct 2005 17:40:28 -0000 1.194
--- ld/Makefile.am 16 Nov 2005 18:40:57 -0000
*************** bootstrap: ld3$(EXEEXT)
*** 1650,1662 ****
# DOCUMENTATION TARGETS
# Manual configuration file; not usually attached to normal configuration,
# because almost all configs use "gen" version of manual.
# Set DOCVER above to change.
configdoc.texi: ${DOCVER}-doc.texi
! ln -s ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi >/dev/null 2>&1 \
! || ln ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi >/dev/null 2>&1 \
! || cp ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi
ldver.texi: $(srcdir)/../bfd/configure
rm -f $@
eval `grep '^ *VERSION=' $(srcdir)/../bfd/configure`; \
echo "@set VERSION $$VERSION" > $@
--- 1650,1661 ----
# DOCUMENTATION TARGETS
# Manual configuration file; not usually attached to normal configuration,
# because almost all configs use "gen" version of manual.
# Set DOCVER above to change.
configdoc.texi: ${DOCVER}-doc.texi
! cp ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi
! echo "@set top_srcdir $(top_srcdir)" >> ./configdoc.texi
ldver.texi: $(srcdir)/../bfd/configure
rm -f $@
eval `grep '^ *VERSION=' $(srcdir)/../bfd/configure`; \
echo "@set VERSION $$VERSION" > $@
Index: ld/Makefile.in
===================================================================
RCS file: /cvs/src/src/ld/Makefile.in,v
retrieving revision 1.208
diff -c -5 -p -r1.208 Makefile.in
*** ld/Makefile.in 30 Oct 2005 17:40:28 -0000 1.208
--- ld/Makefile.in 16 Nov 2005 18:40:57 -0000
*************** bootstrap: ld3$(EXEEXT)
*** 2443,2455 ****
# DOCUMENTATION TARGETS
# Manual configuration file; not usually attached to normal configuration,
# because almost all configs use "gen" version of manual.
# Set DOCVER above to change.
configdoc.texi: ${DOCVER}-doc.texi
! ln -s ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi >/dev/null 2>&1 \
! || ln ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi >/dev/null 2>&1 \
! || cp ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi
ldver.texi: $(srcdir)/../bfd/configure
rm -f $@
eval `grep '^ *VERSION=' $(srcdir)/../bfd/configure`; \
echo "@set VERSION $$VERSION" > $@
--- 2443,2454 ----
# DOCUMENTATION TARGETS
# Manual configuration file; not usually attached to normal configuration,
# because almost all configs use "gen" version of manual.
# Set DOCVER above to change.
configdoc.texi: ${DOCVER}-doc.texi
! cp ${srcdir}/${DOCVER}-doc.texi ./configdoc.texi
! echo "@set top_srcdir $(top_srcdir)" >> ./configdoc.texi
ldver.texi: $(srcdir)/../bfd/configure
rm -f $@
eval `grep '^ *VERSION=' $(srcdir)/../bfd/configure`; \
echo "@set VERSION $$VERSION" > $@
Index: ld/ld.texinfo
===================================================================
RCS file: /cvs/src/src/ld/ld.texinfo,v
retrieving revision 1.152
diff -c -5 -p -r1.152 ld.texinfo
*** ld/ld.texinfo 16 Nov 2005 07:17:20 -0000 1.152
--- ld/ld.texinfo 16 Nov 2005 18:40:58 -0000
***************
*** 1,13 ****
--- 1,15 ----
\input texinfo
@setfilename ld.info
@c Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
@c 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
@syncodeindex ky cp
+ @c man begin INCLUDE
@include configdoc.texi
@c (configdoc.texi is generated by the Makefile)
@include ldver.texi
+ @c man end
@c @smallbook
@macro gcctabopt{body}
@code{\body\}
*************** silently drop the linker options, result
*** 338,347 ****
--- 340,351 ----
Here is a table of the generic command line switches accepted by the GNU
linker:
@table @gcctabopt
+ @include @value{top_srcdir}/../libiberty/at-file.texi
+
@kindex -a@var{keyword}
@item -a@var{keyword}
This option is supported for HP/UX compatibility. The @var{keyword}
argument must be one of the strings @samp{archive}, @samp{shared}, or
@samp{default}. @samp{-aarchive} is functionally equivalent to