3.6. Commiting Changes

Once you have made changes to a file and validated your XML, you are ready to commit the changes to the CVS repository.

When commiting a file or files to the repository, it is polite to supply a brief message of what you have changed. You do not need to document every single line you changed, that is part of CVS' job. However, it is helpful to see a brief summary of what has changed from version to version without having to study the file itself.

To commit a file, issue the following command:

$ cvs commit -m 'added explanation of the new ..blah.. feature' file1 [file2]

Sometimes it is more convenient to omit the -m parameter, as this way CVS opens a text editor and you can type in your comments there. If you would like to add more comments that you can't express on one line using -m, choose this way.

For more information on the conventions used in the XML files that you commit, see Chapter 6.

Note: Please check twice, that you commit changes in the human language the file is written in. The phpdoc module itself only contains English files, so do not commit any files in other languages, unless others agreed on the mailing list. The translation modules should not contain manual content XML files with only English text in them, as this makes translations harder to maintain, so do not commit any English only files to translation trees. If you are not sure you won't make a mistake with committing, please ask on the appropriate mailing list.