summaryrefslogtreecommitdiff
path: root/development/CVSTools/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/CVSTools/README')
-rw-r--r--development/CVSTools/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/development/CVSTools/README b/development/CVSTools/README
new file mode 100644
index 0000000000..f8e1939f97
--- /dev/null
+++ b/development/CVSTools/README
@@ -0,0 +1,26 @@
+The CVSTools provide a simple project versioning system built upon CVS
+which is used by all PADL software. These tools are also required to
+build NetInfo for Linux and our commerial software. The following scripts
+are included in CVSTools:
+
+checkpoint
+Based on Apple's checkpoint program, this creates Perl program the
+CVSVersionInfo.txt file for a work area (when invoked with -create). To
+checkpoint (i.e. increment the version number and create a CVS tag) type
+checkpoint with no arguments, or with the new version number as an
+argument.
+
+cvslib.pl
+Common library functions used by some of these scripts for getting the
+repository and project names. One can override CVSVersionInfo.txt
+location with the CVSVERSIONDIR environment variable, which is useful for
+nested source trees where one wishes to pull in the top level version info
+for the project name, and the current directory name for the program.
+
+tarup
+Executes cvs export and then creates a tarball in
+~/dist/project-version.tar.gz.
+
+vers_string
+Equivalent of OS X's /usr/bin/vers_string, instead using
+CVSVersionInfo.txt the repository and project names.