[PATCH util-macros 0/4] Add doc macros for groff fop, ps2pdf

[Gaetan Nadon]

On Mon, 2010-02-01 at 13:29 -0800, Alan Coopersmith wrote:

> The reason some of these exist as separate options is because some of the docs
> aren't interesting to include in packages, because they're only useful if you're
> working on the source itself, not using the resulting binaries.
> 
> Those should probably all be the same option across the packages -
> enable-devel-docs or something like that, but I'm not sure they should just be
> lumped in with user docs completely.
> 
> 	-alan-
> 

In this first round, I didn't want to get into "classifying" the
documents as, say, user docs vs developer's docs vs sdk docs vs specs.
The only "decision" I made was "man pages" vs "anything else that can be
called a document". The enable-docs option is the one to turn on/off all
documents. 

Nothing prevents us from doing a further classification. It can be
tree-ish (enable-devel-docs nested inside enable-docs) or it can be
parallel (a doc is either a devel-doc or something else) like a case
statement.

It's easy to change when the macros support are in place. Unfortunately,
I am not able to make this document classification by myself. I can add
an additional macro now to avoid bumping the version one more time. It
can be used later when the docs are classified. We have the choice of
the operation, either build, install or distribute for this new
category.

Currently all the docs in (using generation tools) modules are included
in the tarball, a few are not installed. 


> Gaetan Nadon wrote:
> > Second version.
> > 
> > This is the last installment of document generation control macros.
> > The code is identical to the first 3 released, which were well reviewed.
> > 
> > In addition, the XORG_ENABLE_DOCS provides a --enable-docs option intended to replace the
> > various ad hoc options like:
> > enable-devel-docs
> > enable-specs
> > enable-builddocs
> > enable-docs	(this one has been retained)
> > 
> > The default value is "yes" but can be changed in the configuration file:
> > XORG_ENABLE_DOCS(no)
> > 
> > Assumption:
> > The concept of "doc" does not apply to "man pages". They will continue to be build without
> > condition. The exception are those built with xmlto. If the tool is not there,
> > they will be skipped.
> > 
> > For additional info, see http://www.x.org/wiki/Development/Documentation/WritingDocumentation
> > 
> > 
> > Gaetan Nadon (4):
> >   Additional doc macros for GROFF, FOP and PS2PDF
> >   Add XORG_ENABLE_DOCS to control the building of documentation
> >   XORG_WITH_GROFF: add tests for -ms and -mm macro packages
> >   Version bump: 1.6.0
> > 
> >  configure.ac      |    2 +-
> >  xorg-macros.m4.in |  219 +++++++++++++++++++++++++++++++++++++++++++++++++++++
> >  2 files changed, 220 insertions(+), 1 deletions(-)
> > 
> > _______________________________________________
> > xorg-devel mailing list
> > xorg-devel at lists.x.org
> > http://lists.x.org/mailman/listinfo/xorg-devel
> 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.x.org/archives/xorg-devel/attachments/20100201/b4d5ad76/attachment.htm 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part
Url : http://lists.x.org/archives/xorg-devel/attachments/20100201/b4d5ad76/attachment.pgp