This is the mail archive of the binutils@sources.redhat.com 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]

Re: [RFC]: Improvement in binutils man page generation


Hi Stephane,

> I would like to propose the following changes for binutils documentation
> in order to improve man page generation.  The main idea is to follow
> the gcc documentation style:
> 
>   - use @command{name}   instead of @code{name}
>   - use @option{-opt}    instead of @code{-opt}, @samp{-opt} or -opt.
>   - use [@option{-a}|@option{-b}] instead of [ -a | -b ]
>     ie, no space after [ | or before | ]
>   - use @table @env      instead of @table @code
>     for the definition of the list of options.
>     (here, gcc uses @table @gcctabopt)

Well I agree with all of those except for the whitespace around the
vertical bar.  But then I am a fan of putting whitespace everywhere
and I am not going to reject your patch because of this.

> 2001-07-11  Stephane Carrez  <Stephane.Carrez@worldnet.fr>
> 
> 	* doc/binutils.texi: Use @command{name} for commands;
> 	use @option{-opt} for options; use @table @env for list of options;
> 	remove spaces arround [ | ] in synopsis.
> 
> 	* doc/Makefile.am (POD2MAN): Use 'GNU Development Tools' for the
> 	center title.


Approved and applied.  (Sorry for the delay!)

Cheers
        Nick


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