Re: [Sablevm-developer] suggestion: sablevm developer doc

[Chris P. <chr...@ma...>]

Hi,

How about . . . we just have a development branch and the main trunk.=20
Anyone can hack away on the development branch (obviously trying not to=20
break things), and then once in a while Etienne merges changes into the=20
main trunk.  Or some other such multi-developer version control idiom.

This would include a doc module that we can all work on.

Previously, I had experience setting up a doxygen automatically
generated manual for a large, totally undocumented project, and it was
not too difficult and actually quite successful (it gives you an html
code browser for example).   To generate the documentation, one simply=20
typed "make doc".  I could do the same thing for SableVM, and then the=20
JavaDoc comments in files would automatically get included.

Again, as I wrote before, documentation of actual source files needs to
be in the sources themselves.  Documentation of the bigger picture
obviously can go in a separate file.  Latex is fine for this I think
(there's docbook, but everyone knows and loves latex already).  Both=20
kinds of documentation could go in the doc directory.

Cheers,
Chris

P.S.  www.doxygen.org

David B=E9langer wrote:

>Hi,
>
>Concerning the sablevm documentation for developpers, here what I sugges=
t:
>
>Create a new module for the documentation.
>Have a 'draft' and a 'main' directory in that module.
>
>'draft' directory checkin policy: anyone can checkin their draft documen=
tation, no need to wait for Etienne approval.  Developpers could have the=
ir own subdirs.
>draft/chris
>draft/david
>etc.
>
>'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.
>
>
>Comments are welcome.
>
>
>David
>
>---
>
>David B=E9langer
>Graduate Student
>School of Computer Science
>McGill University
>Office: MC226
>
>Web page:   http://www.cs.mcgill.ca/~dbelan2/
>Public key: http://www.cs.mcgill.ca/~dbelan2/public_key.txt
>
>
>
>-------------------------------------------------------
>This SF.net email is sponsored by:Crypto Challenge is now open!=20
>Get cracking and register here for some mind boggling fun and=20
>the chance of winning an Apple iPod:
>http://ads.sourceforge.net/cgi-bin/redirect.pl?thaw0031en
>_______________________________________________
>Sablevm-developer mailing list
>Sab...@li...
>https://lists.sourceforge.net/lists/listinfo/sablevm-developer
>
> =20
>