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

[Per Thomsen]

On 3/31/06 12:35 AM, Ben Summers wrote:
>
> 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.

OK. I already made the Makefile totally separate, and I'll add the
necessary stuff to the manifest.

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

Exactly. The Makefiles generated by 'configure' do need to, at least,
let the user install the man pages in the right spots. Once I have them
written, I would like some help with that.

WRT the web pages, I've seen some installation processes launch a
browser with a 'file:' URL to a page containing links to all the docs. I
like that, because it gives the user access to the docs right away,
without having to install anything into a web server. We will support
the web server option too, but configurations are so varied that it will
be impossible to do this cleanly, so I think supplying a tar file with
all the web stuff, and maybe a simple Apache 'boxbackup.conf' template
that can be dropped into /etc/httpd/conf.d.

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

Yup. It's on my list. I'll put it on the Wiki...

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

Thanks! The Wiki docs were a really good baseline for the installation
and admin guides.

Thanks,
Per

-- 
Per Reedtz Thomsen | Reedtz Consulting, LLC | F: 209 883 4119
V: 209 883 4102    |   pthomsen@reedtz.com  | C: 209 996 9561
GPG ID: 1209784F   |  Yahoo! Chat: pthomsen | AIM: pthomsen