[PATCH libICE docs] Add top-level target for documentation.

Gaetan Nadon memsize at videotron.ca
Tue Nov 23 09:39:39 PST 2010


On Tue, 2010-11-23 at 12:11 -0500, Trevor Woerner wrote:

> So I can predict Gaetan replying to my previous email saying: "let's
> use 'install-docs'" since not all projects have a "specs" directory
> and we want to use the same target across all projects :-D
> 

Yes, he said that, and more :-)

> Sorry, I have no idea if this can or should be cleaned up.
> 

There isn't really anything to "clean-up", not that a new organization
principle
could not be used, provided the benefits are tangible.

The man directory is used for man pages in legacy troff format. A couple
of exceptions
where the man pages are generated from DocBook/XML or ASCIIDOC

The /specs directory contains functional specifications which is a "type
of" document.
http://en.wikipedia.org/wiki/Functional_spec.

The /doc is for user's and developer's documentation. It would probably
be hard to distinguished
between the two. Sometimes both are in  the same logical document.

In the server, there is no central location for docs or specs, there are
close to the code.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.x.org/archives/xorg-devel/attachments/20101123/606daa0c/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/20101123/606daa0c/attachment.pgp>


More information about the xorg-devel mailing list