Changeset 3499

Timestamp:

Mar 24, 2005, 1:20:55 PM (21 years ago)

Author:

jhoblitt

Message:

remove Configuration File Grammar appendix
add Configuration File Test Inputs appendix

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• Makefile (modified) (2 diffs)
• configFileTests.tex (added)
• psLibSDRS.tex (modified) (4 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.75 2005-03-18 04:04:09 jhoblitt Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.76 2005-03-24 23:20:55 jhoblitt Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -505 +505 @@
 \item Change ``Time Tables'' to have IERS Bulliten A \& B
 \end{itemize}
-\end{itemize}
+\item Remove Configuration File Grammar appendix
+\item Add Configuration File Test Inputs appendix
+\end{itemize}

trunk/doc/pslib/Makefile

@@ -1 @@
-# $Id: Makefile,v 1.12 2005-02-10 01:28:07 eugene Exp $
+# $Id: Makefile,v 1.13 2005-03-24 23:20:55 jhoblitt Exp $
 
 PDFLATEX = env TEXINPUTS=.:LaTeX:$(TEXINPUTS): pdflatex
@@ -12 +12 @@
 all : psLibSDRS.pdf psLibADD.pdf
 
-psLibSDRS.pdf: psLibSDRS_Astrom.tex ChangeLogSDRS.tex
+psLibSDRS.pdf: psLibSDRS_Astrom.tex ChangeLogSDRS.tex configFileTests.tex
 psLibADD.pdf: psLibADD.tex ChangeLogADD.tex
 

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.189 2005-03-18 20:44:45 jhoblitt Exp $
+%%% $Id: psLibSDRS.tex,v 1.190 2005-03-24 23:20:55 jhoblitt Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4254 +4254 @@
 @primes U8  2,3 5 7,11,13 17 #   These are prime numbers
 
-comment * # This is a comment in the ITEM_SET item
+comment MULTI # The rest of this line is ignored, but `comment' is set to be non-unique
 comment STR This
 comment STR     is
@@ -4309 +4309 @@
 \end{verbatim}
 
-A BNF-like grammar of the configuration file is contained in
-\S\ref{sec:configgrammar}.
+A series of test inputs is contained in
+\S\ref{sec:configtest}.
 
 \subsection{XML Functions}
@@ -5327 +5327 @@
 \appendix
 
-\section{Configuration File Grammar}
-\label{sec:configgrammar}
-
-Here follows a BNF-like grammar for the configuration files specified
-in \S\ref{sec:configspec}, suitable for use with
-\code{Parse::RecDescent}\footnote{\code{http://search.cpan.org/}$\sim$\code{dconway/Parse-RecDescent-1.94/lib/Parse/RecDescent.pod}}.
-
-\begin{verbatim}
-startrule: statement(s) /\z/
-
-statement: scalar | vector | multi_declare | comment
-
-comment: '#' end_of_line
-
-scalar: name type value comment | name type value
-
-vector: vname vtype vvalue comment | vname vtype vvalue
-
-multi_declare: name '*' end_of_line
-
-name: /[a-z][.\w]*/i
-
-vname: /\@[a-z][.\w]*/i
-
-type:
-    vtype | 'STR' | 'STRING'
-
-vtype:
-    'S8'  |
-    'S16' |
-    'S32' |
-    'S64' |
-    'U8'  |
-    'U16' |
-    'U32' |
-    'U64' |
-    'F32' |
-    'F64' |
-    'C32' |
-    'C64' |
-    'BOOL'
-
-value: vector_value | string
-
-vvalue: vector_value vector_sep vvalue | vector_value vector_sep(?)
-
-vector_sep: ','
-
-vector_value: float | int | bool
-
-int: integer_constant
-
-float: floating_constant
-
-bool: /[tf]\s+?/i
-
-string:
-    /\S[^#\n]*/
-
-end_of_line: /[^\n]*/
-
-### based on syntax found in "C A Reference Manual"
-
-# integer constants
-
-integer_constant:
-    decimal_constant integer_suffix(?) |
-    octal_constant integer_suffix(?) |
-    hexadecimal_constant integer_suffix(?)
-
-decimal_constant:
-    digit(2..) |
-    nonzero_digit
-
-octal_constant:
-    '0' octal_digit(s) |
-    '0'
-
-hexadecimal_constant:
-    hex_prefix hex_digit_sequence
-
-digit:
-    /[0-9]/
-
-nonzero_digit:
-    /[1-9]/
-
-octal_digit:
-    /[0-7]/
-
-hex_digit:
-    /0_9a-f/i
-
-integer_suffix:
-    long_suffix unsigned_suffix(?) |
-    long_long_suffix unsigned_suffix(?) |
-    unsigned_suffix long_suffix(?) |
-    unsigned_suffix long_long_suffix(?)
-
-long_suffix:
-    /l/i
-
-long_long_suffix:
-    /ll/i
-
-unsigned_suffix:
-    /u/i
-
-# floating-point constants
-
-floating_constant:
-    decimal_floating_constant |
-    hexadecimal_floating_constant
-
-decimal_floating_constant:
-    digit_sequence exponent floating_suffix(?) |
-    dotted_digits exponent(?) floating_suffix(?)
-
-digit_sequence:
-    digit(s)
-
-dotted_digits:
-    digit_sequence '.' digit_sequence  |
-    '.' digit_sequence |
-    digit_sequence '.'
-
-exponent:
-    /e/i sign_part digit_sequence
-
-sign_part:
-    /[+-]/
-
-floating_suffix:
-    /[fl]/i
-
-hexadecimal_floating_constant:
-    hex_prefix dotted_hex_digits binary_exponent floating_suffix(?) |
-    hex_prefix hex_digit_sequence binary_exponent floating_suffix(?)
-
-hex_prefix:
-    /0x/i
-
-dotted_hex_digits:
-    hex_digit_sequence '.' hex_digit_sequence |
-    '.' hex_digit_sequence |
-    hex_digit_sequence '.'
-
-hex_digit_sequence:
-    hex_digit(s)
-
-binary_exponent:
-    /p/i sign_part(?) digit_sequence
-\end{verbatim}
+\section{Configuration File Test Inputs}
+\label{sec:configtest}
+
+Here are a series of test inputs for the Configuration File syntax defined in
+\S\ref{sec:configspec}.
+
+\input{configFileTests.tex}
 
 \section{Revision Change Log}