Re: including generated documentation with source

Dag-Erling Smørgrav <[email protected]>
Newsgroups gmane.os.freebsd.chat
Message-ID <[email protected]>
"Jeremy C. Reed" <[email protected]> writes:
> I help maintain documentation (man pages, guides in html, pdf, and plain 
> text, and api/developer docs in html). The original source of the docs 
> is in docbook or doxygen.  I'd prefer not to include the generated docs 
> in the source tree (git repo) because slight differences in the 
> documentation tool chains on each developer's system. But I also don't 
> want the end-user to have to install all the many software dependencies 
> for providing the documentation end results so I include them in my 
> "make dist" tarballs.  (I am using autoconf/automake framework.)

Look at the OpenPAM source code, particularly

http://www.openpam.org/browser/openpam/trunk/doc/man/Makefile.am

Almost all of the man pages are generated at compile time.  The use of
the "dist" prefix in Makefile.am ensures that they are included in the
distribution, even though they are not in the repo.

DES
-- 
Dag-Erling Smørgrav - [email protected]
_______________________________________________
[email protected] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-chat
To unsubscribe, send any mail to "[email protected]"
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.