Changeset 1373 for trunk/psLib/src/mainpage.dox

Timestamp:

Aug 3, 2004, 12:15:59 PM (22 years ago)

Author:

desonia

Message:

updated the locations of snapshots, etc.

File:

• trunk/psLib/src/mainpage.dox (modified) (5 diffs)

trunk/psLib/src/mainpage.dox

@@ -1 @@
-/** @mainpage psLib Image Processing Library - Release 2
+/** @mainpage psLib Image Processing Library
+
 
 @section intro Introduction
@@ -57 +58 @@
 @section install How to Build from Source
 
-The psLib code should to be downloaded from either the tar file posted on: 
+Tested versions of psLib are put into a tar file and can be downloaded from:
 
-https://mhpcc.pan-starrs.org/cgi-bin/viewcvs.cgi/releases/rel2
+https://mhpcc.pan-starrs.org/code/releases
 
-or directly from the CVS server with the following command:
+Though MHPCC recommends using the released packaged tar files descibed above,
+both daily development snapshots and direct CVS access is available.  The daily
+snapshots are available at
+
+https://mhpcc.pan-starrs.org/code/snapshots
+
+These snapshots represents development code as found in CVS on the day 
+specified in the filename.  This code set may not be functional, vary in
+testing, etc.  Reasonable efforts are made to ensure that the code does 
+actually compile, but given the nature of code development, even that is not 
+always the case.  Use snapshots with great caution.
+
+If one has a login account on mhpcc.pan-starrs.org, direct CVS access is  
+possible.  Example of the commands required for direct CVS retrieval are
+as follows:
 <pre>
-$ cvs -d:ext:username@mhpcc.pan-starrs.org:/data/panstarrs/cvsroot co -r rel2_0 psLib
+$ cvs -d:ext:USERNAME@mhpcc.pan-starrs.org:/data/panstarrs/cvsroot co -r RELEASEBRANCH psLib
 </pre>
+where:
+  - USERNAME is your login name on the server
+  - RELEASEBRANCH is the desired release branch, e.g. rel1, rel2, etc.
+    
 
-    
+@section build How to Build the psLib library.
+
 The source should build using the Makefile in the psLib/src directory.  The
 recommended steps are:
@@ -80 +100 @@
 
 Since psLib is a library, there is no executable, per se. However, to test the 
-installation, users may execute the the unit test suite.  To build the unit test
+installation, users may execute the unit test suite.  To build the unit test
 suite, do the following:
 <pre>
@@ -100 +120 @@
 </pre>
 
+Note: one can also fun the FullUnitTest from anywhere within psLib/test
+without performing the above 'make installtests' command first.  To do this,
+one needs to first set the PSLIB_ROOT environment variable to the top psLib
+directory 'psLib'.  FullUnitTest will search for tests in the subdirectories
+the the execution directory, perform a build of them (via 'make'), and run them.
+This can be useful if one wants to tweak the test code and doesn't desire to
+perform an install of all the tests each time the test file is touched.
+
+
 @section doc How to Create Code Documentation
 
-Both HTML and man page documentation may also be generated from the inline 
-documentation in the code using the following commands:
+Both HTML and man page documentation may be generated from the inline 
+documentation embedded in the code using the following commands:
 <pre>
 $ cd psLib/src
@@ -110 +139 @@
 <i>This places documentation in psLib/docs.</i>
 
-Also, a prebuilt set of documentation can be found at:
+Also, a prebuilt set of code documentation for both the releases and last 
+CVS snapshot can be found at:
 
 https://mhpcc.pan-starrs.org/docs/