This is the mail archive of the
binutils@sourceware.org
mailing list for the binutils project.
Re: Avoiding duplication in assembler manual
- From: Nick Clifton <nickc at redhat dot com>
- To: "Joseph S. Myers" <joseph at codesourcery dot com>
- Cc: binutils at sourceware dot org
- Date: Fri, 19 Nov 2010 17:01:56 +0000
- Subject: Re: Avoiding duplication in assembler manual
- References: <Pine.LNX.4.64.1011111808120.5853@digraph.polyomino.org.uk>
Hi Joseph,
I proposed at the time that the duplication should be reduced by
avoiding as.texinfo duplicating target option documentation while
ensuring the documentation in c-$target.texi goes in the generated
manpage. This patch provides a proof-of-concept implementation of
this.
I think that this is a good idea.
The
ugliest part is that the "@c man begin INCLUDE" (required for
texi2pod.pl to process the @include directive) has the corresponding
"@c man end" inside the included c-$target.texi (it needs to go before
the "@c man begin OPTIONS" there).
It would be nice if this could be automated somehow, but I do not see
that happening with a lot more hacking on the documentation.
2010-11-11 Joseph Myers<joseph@codesourcery.com>
* doc/as.texinfo: Refer to or include c-alpha.texi for Alpha
options. Refer to or include c-tic6x.texi for C6X options instead
of duplicating documentation here.
* doc/c-alpha.texi, doc/c-tic6x.texi: Add markup for use in
manpage generation.
Approved - please apply.
Please also ping the maintainers of the architectures that you do not
update, alerting them to this new method.
Cheers
Nick