Changeset 5026

Timestamp:

Sep 13, 2005, 10:28:00 AM (21 years ago)

Author:

desonia

Message:

updated the mainpage: eliminated 'snapshots' and added a section for
installing and linking to the library.

File:

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

trunk/psLib/src/mainpage.dox

@@ -4 +4 @@
  *  @author Robert Daniel DeSonia, MHPCC
  *
- *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-09-08 21:20:52 $
+ *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-09-13 20:28:00 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -66 +66 @@
      - The optional companion package, GraphViz (a.k.a., the 'dot' command), is recommended to enable header-file dependency diagrams
  - MySQL
-     - Required for database functionality
+     - Required for database functionality.  If not desired, the '--disable-mysql' configure option should be used.
      - Available at http://dev.mysql.com
      - Compatibility tested with version 4.1.10a, requires at least 4.1.2
-     - A server running locally is required for testing.
+     - A server running locally is required for tests.
  - Autoconf/Automake
      - Required only if making from CVS
      - Available at http://www.gnu.org/software/autoconf and http://www.gnu.org/software/automake
-     - Compatibility tested with version 2.59 (autoconf) and 1.9.2 (automake)
+     - Compatibility tested with version 2.5.9 (autoconf) and 1.9.2 (automake)
 
 We recommend using the particular versions listed as compatibility tested, as
-that is the only versions of the external libraries tested to work well with psLib.
-Though it is quite possible that later versions of the libraries listed will also
-work as well, care must be taken when upgrading these libraries to verify that its
+that is the only versions tested to work well with psLib. Though it is quite 
+possible that later versions of the libraries listed will also work as well, 
+care must be taken when upgrading these libraries to verify that its
 functionality is compatible with the tested version.
 
@@ -88 +88 @@
 https://mhpcc.pan-starrs.org/code/releases
 
-Though MHPCC recommends using the released packaged tar files descibed above,
-both recent daily development snapshots and direct CVS access is available.
-The recent 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
+If one has a login account on mhpcc.pan-starrs.org, direct CVS access is also
 possible.  Example of the commands required for direct CVS retrieval are
 as follows:
@@ -108 +96 @@
 where:
   - USERNAME is your login name on the server
-  - RELEASEBRANCH is the desired release branch, e.g. rel5.
+  - RELEASEBRANCH is the desired release branch, e.g. rel7.
 
 
 @section build How to Build and Test
 
-The source uses autoconf/automake to build control the build process.  If, and
-only if, the source came from CVS or a CVS snapshot, the configuration script
-will have to be made via:
+The source uses autoconf/automake to build control the build process.  If, 
+and only if, the source came from CVS, the configuration script will have
+to be made first via:
 <pre>
 $ cd psLib
-$ make -f Makefile.cvs
+$ ./autogen.sh
 </pre>
-<i>This creates the configure script and Makefile templates.</i>
+<i>This creates the required configure script and Makefile templates.</i>
 
 The recommended steps to build the library are:
@@ -153 +141 @@
 </pre>
 
+@section install How to Install
+
+To install the library using the prefix given in the configure step, execute in
+the top build directory:
+<pre>
+$ make install
+</pre>
+
+
 @section usage Building and Linking your code to the psLib library
 
@@ -167 +164 @@
 link to the pslib library.
 
+Note: pslib-config usage above refers to the install locations of the library.  
+To link to the library directly in the build area, you need to use
+'pslib-config --build-cflags' and 'pslib-config --build-libs' instead.  These
+options will modify the output to point to the non-installed (build) locations
+of the include files and libraries. (this feature is experimental)
+
 @section doc How to Create Code Documentation
 
@@ -178 +181 @@
 the configure script.</i>
 
-Also, a prebuilt set of code documentation for both the releases and last
-CVS snapshot can be found at:
+Also, a prebuilt set of code documentation for releases and can be found at:
 
 https://mhpcc.pan-starrs.org/docs/