|CSC 223||Grinnell College||Fall, 2006|
This lab provides practice with CVS (a Concurrent Versions System) within the context of the class project.
As the class progresses from the specification and design stages of the various projects to coding, coordination of group efforts becomes particularly important. Specifically, we must work within a system that allows the following:
Each person within a group must be able to code, modify, compile, and test her/his class(es) independently of other students. That is, when code is under development by a student, that code should not prevent other group members from coding and testing their work.
When an individual has reached a stable point within her/his code development, the code should be made available to the rest of the students in the group.
As a student is testing, the testing should take place using the latest stable classes from other students in the group.
CVS is a version control system designed specifically to address the needs of groups developing software, documentation, and other materials. While some details of CVS may be specific to this version control system, many of the basic ideas apply quite generally. Thus, as students move from this project in this course to other projects either at Grinnell or elsewhere, students are likely to find similar ideas employed in whatever software development system they encounter. Details may differ, but many control systems will have a similar purpose, and developers will finding programming in such environments share common elements.
Information of CVS (a Concurrent Version System) may be found on-line in three ways:
info cvsin a terminal window. Basic movement through this documentation proceeds as follows:
info cvsin a terminal window.
Work with CVS requires some initialization and preparation. Thereafter, work follows a relatively simple pattern.
cvs.cs.grinnell.edu. While one could include directions to this server with each CVS interaction, work is simplified by placing the a few lines in your file
.bash_profile, found in your home directory. The following code is designed for the instructor (username
# Use the CVS repository at cvs.cs.grinnell.edu. CVSROOT=:pserver:firstname.lastname@example.org:/cvs export CVSROOT
walkerto your own username.
.bash_profile, you will either need to log out and back in again or you can run the command
from the terminal window you will use in the following steps.
Access to the CVS is password protected. However, once you log in a first
time, your account places password information in file
.cvspass in your home directory. Since this information is
stored in clear text, you should not use your regular password. (For this
course, Mr. Stone will assign random passwords to each student. After a
first use, you are unlikely to need to remember this detail further.)
You will be prompted for your password.
With this work done correctly, you will NOT need to use the cvs login command in future interactions.
To use CVS for a project, one project-group member must place the new project into CVS. In the jargon of CVS, the new project is imported into the CVS system.
The following approach is strongly recommended for each CSC 223 project.
Use ArgoUML to generate the main Java class files for your project.
At this point, you should have a project directory that contains a copy of your ArgoUML class diagram(s) and your newly-created Java class files. This project directory should NOT contain any other files.
Now use these new files as the basis for your project files with CVS.
Within a terminal window, change directory to the newly-created directory from step 5.
Create the new project within CVS with the command:
cvs import -m "project initialization" projname username start
To clarify this line:
At this point, your system should be entered into CVS. Note, however, that the material in the current directory is not considered to be a CVS working copy of your system. A working copy of the system requires that you check out a current version from CVS. That is the next part of this lab.
In working with CVS you will want to base your activity at a logical subdirectory. The following commentary assumes you have moved to that subdirectory in a terminal window.
After initial set up, normal use of CVS on MathLAN follows these several steps:
|Get source files||Obtain new copies of files for the |
|Edit ||Change directory to the projname project|
Start editing your file
|Commit changes||Put the new version of |
|Clean up||Move up one directory|
check modifications are committed before removing files
verify you want to remove committed files/directories
For this course, each group will be responsible for working on its own project. The group will need to determine who will be working with which classes when; that is, project management is left to each group. Please talk with the instructor early and often to clarify these assignments.
While CVS allows any user to revise any file, such flexibility could undermine development of software if one group member were to change the files of another. Further, changes must be controlled, so that software found in the CVS repository represents stable, working code. This leads the following rules for this course:
Groups are expected to change their own project files only; a group may not change files of other group's project!
Each group must clarify which person will be developing the code for which classes(s). Then, each individual should modify only those files assigned by the group. An individual can check out a full colleciton of class files for the project, but the individual should edit only those assigned by the group.
Individuals should commit changes to their files ONLY after compiling and testing those changed files with the stable files from other group members.
Using these rules as a base, you should try checking out classes, changing your class(s), committing the change, and cleaning up.
[In a collaborative effort, one person in a group should import your group's classes into CVS, but this need not be documented directly.]
created 31 March 2002|
last revised 13 October 2005
|For more information, please contact Henry M. Walker at email@example.com.|