[Box Backup-dev] [Doc] Autoconf/automake/aclocal help...

Ben Summers boxbackup-dev@fluffy.co.uk
Fri, 31 Mar 2006 09:35:00 +0100


On 25 Mar 2006, at 20:22, Per Thomsen wrote:

> All,
> I have been busy lately, so I only got time last night to sit down and
> start looking at the makefiles, etc. for the documentation project.
>
> Is there any documentation available on what is the best way to
> integrate the documentation into the build environment?
>
> I would like to be able to release completed docs in the source
> distribution (ie. the 0.10 tarball), so folks don't have to have  
> DocBook
> XSL, and xsltproc installed (although most distros I looked at do
> include it) to build Box.
>
> So, the doc stuff could be a separate makefile, not tied to autoconf,
> etc., and only be invoked by those who want to change the docs. Then
> when it's time to build the release, the documentation tarball is
> created, and stuffed into the release.
>
> Of course, installation of the docs would still need to be a part  
> of the
> makefiles.
>
> Thoughts?

Sorry for the delay...

I would make the docs makefile a completely separate thing, but add a  
RUN line in distribution/boxbackup/DISTRIBUTION-MANIFEST.txt to make  
the docs, and another line to copy them into the archive.

That way you only need to have the docbook tools if you're doing  
documentation or building a release archive.

Oh, and you also need to document how to get the docbook tools. If  
you haven't already done so.

Thanks for all your hard work. It's looking good!

Ben