Re: [Sablevm-developer] suggestion: sablevm developer doc
Brought to you by:
egagnon
From: Grzegorz B. P. <ga...@de...> - 2003-03-17 20:24:36
|
W li=B6cie z pon, 17-03-2003, godz. 20:07, David B=E9langer pisze:=20 > Hi, >=20 > Concerning the sablevm documentation for developpers, here what I suggest= : >=20 > Create a new module for the documentation. > Have a 'draft' and a 'main' directory in that module. >=20 > 'draft' directory checkin policy: anyone can checkin their draft > documentation, no need to wait for Etienne approval. Developpers > could have their own subdirs. > draft/chris > draft/david > etc. >=20 > 'main': This is the complete or almost complete doc that has been > reviewed. We have control of what gets put there e.g. only Etienne > checkin stuff there. Hmm... I think I've been reading all recent emails and I haven't seen such big documentation flood :-) I don't know how much documentation we should expect to appear, but I doubt it'd be THAT much of it and so soon that would mandate separete module (and separate tarball). I think I'd rather create 'doc' directory in sablevm module where all approved docs should appear (even Etienne's PhD thesis if for ex. he would like them to be distributed in debian packages). As for the developers' directories. I've seen (for ex. in FireBird) that developers usually have their own subdirs where they keep their own stuff which, for some reason, is not included into the mainline [0]. Again - I think I'd put these dirs in sablevm module for the reason similar to why I wouldn't create new module for docs. KISS - we should not overengineer things. Just my 0.03CAD :-) (about 0.08PLN currently) Grzegorz B. Prokopski [0] Firebird developers have their "home"/"own" dirs in 'firebird' directory in 'firebird' module but I wouldn't go along this pattern. Maybe dir like 'developers' for developers' own dirs would suffice? --=20 Grzegorz B. Prokopski <ga...@de...> Debian http://www.debian.org/ |