Changeset 9679 for trunk/psModules/src/config/pmConfig.h

Timestamp:

Oct 20, 2006, 1:03:35 PM (20 years ago)

Author:

Paul Price

Message:

Cleaning up, adding a few more details.

File:

• trunk/psModules/src/config/pmConfig.h (modified) (6 diffs)

trunk/psModules/src/config/pmConfig.h

@@ -9 +9 @@
 /// @author Eugene Magnier, IfA
 ///
-/// @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
-/// @date $Date: 2006-10-16 22:03:56 $
+/// @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-20 23:03:35 $
 ///
 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
@@ -62 +62 @@
                        );
 
-/// Set configuration information
+/// Set static configuration information
 ///
 /// The search path for the configuration files is a local static variable, set by this function.
@@ -68 +68 @@
                 );
 
-/// Free memory used in the configuration system
+/// Free static memory used in the configuration system
 void pmConfigDone(void);
 
@@ -74 +74 @@
 ///
 /// pmConfigRead loads the site configuration (the file name is specified by "-site SITE_FILE" on the
-/// command-line, the PS_SITE environment variable, or it is $HOME/.ipprc).  The camera configuration is
-/// loaded if it is specified on the command line ("-camera CAMERA_FILE"). Recipes specified on the command
-/// line ("-recipe RECIPE_NAME RECIPE_SOURCE") are also loaded.  These command-line arguments are removed from
-/// from the command-line, to simplify parsing.  The psLib setups are also performed if specified in the site
-/// configuration.
+/// command-line, the PS_SITE environment variable, or it is $HOME/.ipprc).  The configuration search path is
+/// set. The camera configuration is loaded if it is specified on the command line ("-camera
+/// CAMERA_FILE"). Recipes specified on the command line ("-recipe RECIPE_NAME RECIPE_SOURCE") are also
+/// loaded.  These command-line arguments are removed from from the command-line, to simplify parsing.  The
+/// psLib log, trace and time setups are also performed if specified in the site configuration.
 pmConfig *pmConfigRead(int *argc,       ///< Number of command-line arguments
                        char **argv      ///< Array of command-line arguments
@@ -119 +119 @@
 /// Read recipes
 ///
-/// Attempt to read recipes from the sources that are available but have not already been read.
+/// Attempt to read recipes from the sources that are available but have not already been read.  Having read a
+/// recipe, attempt to resolve symbolic links that were specified on the command line.
 bool pmConfigReadRecipes(pmConfig *config ///< Configuration
                         );
 
-/** pmConfigDB
- *
- * pmConfigDB shall use the site configuration data to open a database handle.
- * This is fairly straightforward at the moment, but will change when we beef up
- * security. (TBD)
- *
- */
 /// Setup the database
 ///
@@ -136 +130 @@
 psDB *pmConfigDB(pmConfig *config       ///< Configuration
                 );
-
-/** pmConfigConformHeader
- *
- * Make the supplied header conform to the nominated camera format.
- */
 
 /// Make the supplied header conform to the nominated camera format.