This is the mail archive of the binutils@sourceware.org mailing list for the binutils project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

PATCH: Document "@FILE" in GAS manual.


Now that texi2pod.pl can handle "@include @value{...}" we can add
documentation for @FILE to binutils programs by simply including the
Texinfo fragment from libiberty.  Here's an implementation of that
idea for gas; if approved, I'll do the same for gprof, ld, and for
binutils (which presently has its own documentation for @file, rather
than using the libiberty version).

Tested by looking at the generated .info in emacs and by looking at
the generated manual page with man.  OK to commit?  If so, should I
consider similar patches for the other directories prepapproved, or
would you prefer to review them as well?

(This really is the last round of patches for this functionality, so
far as I am aware.)

Thanks,

--
Mark Mitchell
CodeSourcery, LLC
mark@codesourcery.com

2005-10-30  Mark Mitchell  <mark@codesourcery.com>

	* gas/doc/Makefile.am (asconfig.texi): Set top_srcdir.
	* gas/doc/Makefile.in: Regenerated.
	* gas/doc/as.texinfo: Document "@FILE".

Index: gas/doc/Makefile.am
===================================================================
RCS file: /cvs/src/src/gas/doc/Makefile.am,v
retrieving revision 1.37
diff -c -5 -p -r1.37 Makefile.am
*** gas/doc/Makefile.am	25 Oct 2005 17:40:18 -0000	1.37
--- gas/doc/Makefile.am	30 Oct 2005 18:11:45 -0000
*************** man_MANS = as.1
*** 17,29 ****
  
  info_TEXINFOS = as.texinfo 
  
  asconfig.texi: $(CONFIG).texi
  	rm -f asconfig.texi
! 	ln -s $(srcdir)/$(CONFIG).texi ./asconfig.texi >/dev/null 2>&1 \
! 	  || ln $(srcdir)/$(CONFIG).texi ./asconfig.texi >/dev/null 2>&1 \
! 	  || cp $(srcdir)/$(CONFIG).texi ./asconfig.texi
  
  CPU_DOCS = \
  	c-alpha.texi \
  	c-arc.texi \
  	c-arm.texi \
--- 17,28 ----
  
  info_TEXINFOS = as.texinfo 
  
  asconfig.texi: $(CONFIG).texi
  	rm -f asconfig.texi
! 	cp $(srcdir)/$(CONFIG).texi ./asconfig.texi	
! 	echo "@set top_srcdir $(top_srcdir)" >> ./asconfig.texi
  
  CPU_DOCS = \
  	c-alpha.texi \
  	c-arc.texi \
  	c-arm.texi \
Index: gas/doc/as.texinfo
===================================================================
RCS file: /cvs/src/src/gas/doc/as.texinfo,v
retrieving revision 1.137
diff -c -5 -p -r1.137 as.texinfo
*** gas/doc/as.texinfo	25 Oct 2005 17:40:18 -0000	1.137
--- gas/doc/as.texinfo	30 Oct 2005 18:11:47 -0000
*************** gcc(1), ld(1), and the Info entries for 
*** 229,240 ****
   [@b{-K}] [@b{-L}] [@b{--listing-lhs-width}=@var{NUM}]
   [@b{--listing-lhs-width2}=@var{NUM}] [@b{--listing-rhs-width}=@var{NUM}]
   [@b{--listing-cont-lines}=@var{NUM}] [@b{--keep-locals}] [@b{-o}
   @var{objfile}] [@b{-R}] [@b{--reduce-memory-overheads}] [@b{--statistics}]
   [@b{-v}] [@b{-version}] [@b{--version}] [@b{-W}] [@b{--warn}]
!  [@b{--fatal-warnings}] [@b{-w}] [@b{-x}] [@b{-Z}] [@b{--target-help}]
!  [@var{target-options}] [@b{--}|@var{files} @dots{}]
  @c
  @c Target dependent options are listed below.  Keep the list sorted.
  @c Add an empty line for separation. 
  @ifset ALPHA
  
--- 229,241 ----
   [@b{-K}] [@b{-L}] [@b{--listing-lhs-width}=@var{NUM}]
   [@b{--listing-lhs-width2}=@var{NUM}] [@b{--listing-rhs-width}=@var{NUM}]
   [@b{--listing-cont-lines}=@var{NUM}] [@b{--keep-locals}] [@b{-o}
   @var{objfile}] [@b{-R}] [@b{--reduce-memory-overheads}] [@b{--statistics}]
   [@b{-v}] [@b{-version}] [@b{--version}] [@b{-W}] [@b{--warn}]
!  [@b{--fatal-warnings}] [@b{-w}] [@b{-x}] [@b{-Z}] [@b{@@@var{FILE}}]
!  [@b{--target-help}] [@var{target-options}]
!  [@b{--}|@var{files} @dots{}]
  @c
  @c Target dependent options are listed below.  Keep the list sorted.
  @c Add an empty line for separation. 
  @ifset ALPHA
  
*************** gcc(1), ld(1), and the Info entries for 
*** 448,457 ****
--- 449,460 ----
  @end smallexample
  
  @c man begin OPTIONS
  
  @table @gcctabopt
+ @include @value{top_srcdir}/../libiberty/at-file.texi
+ 
  @item -a[cdhlmns]
  Turn on listings, in any of a variety of ways:
  
  @table @gcctabopt
  @item -ac


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]