Changeset 1692

Timestamp:

Sep 3, 2004, 6:29:14 PM (22 years ago)

Author:

Paul Price

Message:

Minor changes to config files.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (4 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.107 2004-09-04 04:23:21 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.108 2004-09-04 04:29:14 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -3531 +3531 @@
 \end{verbatim}
 
-Given a previously allocated metadata container, \code{md}, and the
-name of a configuration file, \code{filename},
-\code{psMetadataParseConfig} shall parse the configuration file,
-placing the contained key/type/value/comment quads into the metadata,
-and returning the number of lines that failed to parse.  Multiple
-specifications of a key that haven't been declared (see below) are
-overwritten if and only if \code{overwrite} is \code{true}.
+Given a metadata container, \code{md}, and the name of a configuration
+file, \code{filename}, \code{psMetadataParseConfig} shall parse the
+configuration file, placing the contained key/type/value/comment quads
+into the metadata, and returning the number of lines that failed to
+parse.  Multiple specifications of a key that haven't been declared
+(see below) are overwritten if and only if \code{overwrite} is
+\code{true}.
+
+If the metadata container is \code{NULL}, it shall be allocated.  If
+the file specified by \code{filename} is not readable, then the
+function shall generate an error and return \code{-1}.
 
 The configuration file shall consist of plain text with
@@ -3557 +3561 @@
 
 \tbd{May, in the future, require more types, including
-\code{U8,S16,C64}, which will necessitate updating the definition of
-\code{psMetadata}.}
+\code{U8,S16,C64}, which will also necessitate updating the definition
+of \code{psMetadata}.}
 
 The value shall follow the type: strings may consist of multiple
@@ -3616 +3620 @@
 comment * The rest of this line is ignored, but `comment' is set to be non-unique
 comment STR This
-comment STR      is
-comment STR         a
-comment STR           non-unique
-comment STR                      key
+ comment STR     is
+  comment STR       a
+   comment STR        non-unique
+    comment STR                  key
 Float F64 1.23456 # This generates a warning, and, if `overwrite' is `false', is ignored
 \end{verbatim}