ht://Dig Copyright © 1995-2001 The ht://Dig Group
Please see the file COPYING for
license information.
If you have never used CVS or have not used it in a long time, please read the online CVS manual. In particular, chapters 1, 7, and 11 are important to understanding how CVS works and how it will be used for ht://Dig development. You will also need to be familiar with Chapters 2, 3, 4, 6, 9, 10, and appendixes A, B, and D. Don't worry about this assignment as it is useful stuff and definately something you can put on your resume. :-)
Once you understand how CVS works, and you have signed up to get
access to the CVS repository, you can check out the various
modules. The instructions that follow assume that you have the
cvs command in your path and that you have enough free
disk space to store the sources.
Before you can perform any CVS operations, you will need to create a file with a somewhat encrypted version of your password. To do this use the following:
cvs -d :pserver:username@cvs.htdig.org:/opt/htdig/cvs
login
where username is your username. This will prompt for your
password. It will verify that you can access the CVS repository on
cvs.htdig.org.
Now you need to checkout the ht://Dig modules you want to work on. There are several modules available from the CVS repository. Currently they are:
| CVS Module | Description |
|---|---|
| htdig3 | The source tree for ht://Dig version 3 |
| htdig4 | The source tree for ht://Dig version 4 (currently inactive) |
| devdocs | The HTML and images used for http://www.htdig.org/dev/ |
| maindocs | The HTML and images used for http://www.htdig.org/ |
| files | The binaries and snapshots for http://www.htdig.org/files/ Note this is quite large and usually isn't needed. |
To checkout a module, change directory to a place with enough disk space and enter:
cvs -d :pserver:username@cvs.htdig.org:/opt/htdig/cvs
checkout module
where module is one of the available modules. This operation
will create a new directory with the name of the module which
contains all the HEAD revisions of all the files in the
module.
A sample checkout will look something like this:
ender: [413]--$ cvs -d :pserver:turtle@cvs.htdig.org:/opt/htdig/cvs checkout htdig4
U htdig4/startup.props
U htdig4/tables.sql
U htdig4/bin/recompile
U htdig4/bin/robot
U htdig4/lib/checktime.c
U htdig4/lib/htdig.prp
U htdig4/lib/instantdb.jar
U htdig4/lib/sqlsyntax.txt
U htdig4/robot/org/htdig/robot/Robot.java
U htdig4/robot/org/htdig/util/ConnectionPool.java
U htdig4/robot/org/htdig/util/Props.java
U htdig4/robot/org/htdig/util/RunSQL.java
U htdig4/robot/org/htdig/util/Template.java
ender: [414]--$
There are only a couple of CVS commands which you will
need to use on a regular basis. These are:
| Command | Description |
|---|---|
| cvs add | To add new files or directories to the module |
| cvs update | To retrieve and merge any changes that others have made with the local copy of the module |
| cvs commit | To move changes you have made to your local copy of the module into the main module so that others can see what you did. |
| cvs remove | To remove files from the module. |
Please read the CVS manual on the details of these commands. Please note that anyone intending on using the CVS tree should keep it up to date as much as possible. You may do this either by setting a crontab entry to update your local copy or by href="http://www.htdig.org/mailing.html">subscribing to the htdig3-updates mailing list, which recieves a message for every commit.