FSL Developers Guide

To import an existing directory/project simply skip the mkdir step. However one should note an import will include all the files in the directory and this probably isn't what you want.

First create the new project directory and import it into CVS:

The current directory should then be discarded and a copy checked out from the cvs repository, which is necessary to get a local CVS directory that is needed by other cvs commands (like adding files - see below)

It is recommended that you check copies out to a directory other than FSLDEVDIR. This will help avoid mistakes when updating sources back into the repository.

CVS allows you to create and maintain local copies of the sources. Each developer works on his/her own copy and, periodically, commits their changes to the source repository. If a developer wants to get changes that other developers have committed then they need to perform an update of the local copy.

Although the sources can be put anywhere, it is better to keep them out of the ${FSLDEVDIR} tree, as it avoids problems with accidental check-ins and check-outs.

Create a local copy of the project you want to edit:

This will create a directory called <projectname> in the current directory. Each subdirectory of <projectname> will also contain a directory called CVS. These are CVSs control files and you should leave them alone unless you know precisely what you're doing.

Edit these sources and when you're happy with the changes commit them back into the repository.

(Before committing changes you may want to update your local sources. CVS will stop you from committing changes which clash with other developers changes.)

If you don't tell CVS which files to work on then it will automatically process the whole directory.

If you have checked out a project, e.g., utils, so that you can use the latest version of it, then you'll probably want to know when someone changes it. CVS helps by letting you sign up for notification when events occur on files within a project. To get notifications via e-mail when someone commits changes to a project you must add yourself to the watch list of the files as follows:

You won't be notified if someone adds a file to the project since you won't automatically be a watcher of the new file. This is an unavoidable weakness in this scheme.

And to remove yourself from the watch list:

From time to time you will need to incorporate other peoples changes to a local copy you are maintaining. Use cvs status to see if any source file "Needs patch". The cvs update command will patch the files unless there is a conflict, i.e., your local changes would be lost.

You will not be able to commit your changes to a file until you have resolved all conflicts.

If two versions do conflict then CVS will place a version of the file in your directory with both possible changes highlighted in it. It will then be up to you to resolve the differences and commit the corrected file.

The repository should not contain any files which are being generated, e.g., via the compilation process. The depend.mk file would be an example of a file which should not be in the repository.

Before adding a file to the repository first make sure you really need it in there. The repository should only contain those files needed to build the project, i.e., Makefile, scripts, sources, headers, documentation and, possibly, required data.

To add new files to the project:

Binary files need to be added with a special option to stop CVS from doing keyword substitutions, i.e., cvs add -kb ashes.jpg

Files never really get removed from the repository. If you tell CVS to remove a file it puts in that directories Attic so that it can still recreate old versions of the source tree. To remove a file first delete it from the local copy then commit your changes as follows:

Simply remove the directory. Any uncommitted changes will be lost. You will still be watching the project if you had a watch on it. So cvs watch remove if appropriate.