Nick Bastin wrote:
> Does anybody have an issue with me moving the toplevel files README, TODO,
> and ChangeLog into the docs tree, and then providing a 'make package' in
> the toplevel makefile which will produce those docs and move them into the
> appropriate parts of the tree? I'd at least like to pull ChangeLog and
> TODO under the docs/ tree, but it's just for convenience, so feel free to
> shoot me down.. :-)
Well ... The ChangeLog isn't really part of the docs in any case;
it is basically an append-only file documenting all changes to the
tree. Currently, I'm adding a new entry whenever I commit a patch to
CVS; in the future this might even be auto-generated from the CVS
commit logs.
As to the other files: I don't really like the idea of a 'make package',
because IMO released packages should just be shapshots of the CVS tree
(generated by cvs export, say). This way, you avoid introducing
discrepancies between the trees seen by developers (CVS checkout)
and users downloading a FTP package.
This is especially important in the case of README: it is really
to be expected that a package you look at the first time, whether
by downloading a package or by checking out the CVS tree, has a file
called README in its root directory. This is simply the first place
to look. (In fact, it's even mandatory according to the GNU package
layout rules :-/)
Why do you want to move those files in the first place? Those are
just text files, not generated by any mechanism, so what's the
difference where they reside?
Bye,
Ulrich
--
Ulrich Weigand,
IMMD 1, Universitaet Erlangen-Nuernberg,
Martensstr. 3, D-91058 Erlangen, Phone: +49 9131 85-27688
