Documentation

Jouni Heikniemi jth at mikrobitti.fi
Wed Jan 28 07:56:45 UTC 2004


At 07:52 28.1.2004 +0000, you wrote:
>Suggestion: we could get the website build script to also build a 
>documentation tarball (HTML, text and PDF), and checksetup.pl could offer 
>to download and unpack it if there is no documentation present. This would 
>only ever happen on CVS checkouts, as we'd be shipping docs in all the 
>release tarballs anyway. So we wouldn't have problems worrying about 
>version skew.

I'd be totally happy if a cvs pull contained a short html (or text) file in 
the docs/html dir that contains the address to the current documentation. A 
downloadable tarball (or something more easily cross-platform, a .zip 
perhaps?) is good enough, making checksetup.pl do semi-automatic downloads 
is pampering the users too much (;-)). Besides, it adds another external 
dependency and may prove problematic with firewalls.

Other than that, I agree.


Jouni





More information about the developers mailing list