|STAR Computing||Tutorials main page|
|How to document software packages|
|Offline computing tutorial|
Package documentation resides in the CVS repository together with the code. There are two levels of documentation for each package:
docsubdirectory under the package directory which contains reliable information about performance and usage of the package. The main page should be in
index.html. The main page may contain little more than links pointing to the doc resident elsewhere; it's up to you. The important thing is that the page guide the user through detailed documentation enabling them to understand and use the package.
PackageDirectory |-----README |-----doc |---index.html
-m "comment"on the commit command line, but you can also enter more extended comments by leaving off the -m option. You will be put into an editor in which you can enter as descriptive a comment as you like; when you save+exit the editor your comment will be saved and the commit processed. The editor used follows the CVSEDITOR environment variable if it is set, otherwise the EDITOR environment variable (eg.
setenv CVSEDITOR "emacs -nw").
If you have changed multiple files for multiple reasons you can also ensure that the proper comments are associated with the proper files by committing the files separately, eg.
cvs commit -m "Comment 1" file1 cvs commit -m "Comment 2" file2 file3