CVS is a popular free revision control system. It is designed to allow one or more people to work on the same project, keeping checked in versions of files in a common repository. Its main use is for managing source code in projects with multiple developers, and it includes some pretty nifty support for merging independent changes to text files. In fact, using some sort of revision control is almost required for any reasonably complex software project. The revision tracking features are pretty handy even when working alone. You can go back to any revision of your files that was ever checked into the repository, either by revision number or date.
In our case, you will be checking in your project files, and the TAs will be checking them out to grade. I encourage you to check in changes often, but in the end you just need to make sure the required files are checked in for each project by the deadline.
First, you must check out your directory from the repository. This will give you your own working copy of any files supplied by the instructors for the project as well as files needed by CVS to manage your code properly. Do not attempt to work directly in the repository, CVS will get quite confused if you do this, and we probably won't be able to check out your code to grade it. On the GL systems, you'd use a command like this:
cvs -d /afs/umbc.edu/users/r/b/rberge1/pub/class_name/project_name checkout -d directory_name_of_your_choice your_umbc_loginFor example, if your username is jones5 and you're taking 341 in the Spring of 2009, you might use the following command line to check out project 0:
cvs -d /afs/umbc.edu/users/r/b/rberge1/pub/cs341s09/Proj0 checkout -d MyProj0 jones5
This will create a directory called MyProj0 containing everything you need to start using CVS for the project. This is the only time you need to tell it where the repository is. After the intial checkout, once you cd into your newly created directory (in this case, MyProj0), CVS can figure out which repository to use. All of the major CVS commands apply to the current directory and all directories under it.
Edit away... No need to do anything special
If you add files, such as a new .java file, you need to let CVS know so they'll be checked in:
cvs add file
To tell CVS you're removing a file (so it won't come back next time you update — see below):
cvs remove -f file
To tell CVS to ignore a file add it to the list in the .cvsignore file (which you'll need to create with a text editor if you want to use this functionality of CVS) in that directory. You should do this for .class files, otherwise CVS stores version control information for them each time you check in your project.
Your changed or added files are not copied to the repository until you check them in. You must do this for us to be able to check out and grade your work, but you can do it as many times as you want before then. First do this:
cvs -q update
Files CVS doesn't know about will be listed with a '?'. Next, tell CVS to add or ignore each of them, then try the update again. It's good practice to make sure CVS knows about every file before you commit any check in.
Now check them into the repository:
An editor will pop up, showing you a listing of what will be checked in. You can enter a log message here to say what was in the checkin. This message is for you: We will not look at the log messages for grading, but it can be useful if you want to look back at old versions later. You can change editors by setting the EDITOR environment variable (the default editor is vi), but whatever editor you use must not normally return to a prompt right away, and you must quit that instance of the editor after writing your log message for the commit to complete. (CVS tells that you're done editing the log message when the editor returns)If you'd rather not have the editory pop up, and have a short log message, you can specify it on the command line as follows:
cvs commit -m 'the log message'
Now check to make sure it worked:
cvs -q update
This time, it shouldn't list any files. If it does, something went wrong. Make sure you've told CVS to add or ignore if necessary, and try again, or ask for help. The first time you check in, you may want to follow the checkout directions to make a second copy (under a different name), just to see what we'll get.
If we make any changes to files we supply (or add some for the later assignments), you can get these using
cvs update -d
You can compare your current file with any previous version (dates are GMT; for a local date, use something like '1/1/05 13:15 EST')
cvs diff -D date file
To figure out which revision is which (assuming you entered reasonable log messages when you committed your changes), do
cvs log file
You can actually get a full copy of an old file revision with
cvs update -D date file
but be careful with this; CVS remembers that you went back in time and will refuse to check in changes you make to the old file. To get back to the latest version, do
cvs update -A file
If you just want to throw away your current edits to start again from the last checked-in version, just remove the file and re-update. If you want to toss several revisions, go ahead and do the -D, make a copy, do the -A, then replace the file with your copied old revision.
List of all CVS commands
Help on any one CVS command
cvs --help command
General CVS manuals, downloads, etc.: www.cvshome.org