[cig-commits] [commit] master: Document the fact that lines in the parameter file can end in a backslash. (8af65d3)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/aspect

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/b1709845591f347112ebb0d7c06092f25ab52866...1244665320d2d46ebc49df3e80bcb4daaad7b287

>---------------------------------------------------------------

commit 8af65d3482644ae8568aacdfe12d72d2739c9c71
Author: Wolfgang Bangerth <bangerth at math.tamu.edu>
Date:   Mon May 19 20:46:32 2014 -0500

    Document the fact that lines in the parameter file can end in a
    backslash.


>---------------------------------------------------------------

8af65d3482644ae8568aacdfe12d72d2739c9c71
 doc/manual/manual.tex | 15 +++++++++++----
 doc/modules/changes.h |  5 +++++
 2 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/doc/manual/manual.tex b/doc/manual/manual.tex
index 7890d1c..96c23c2 100644
--- a/doc/manual/manual.tex
+++ b/doc/manual/manual.tex
@@ -2499,8 +2499,8 @@ thing to the left of the equals sign) and a content (what's to the right).
 
 All parameters you can list in this input file have been \textit{declared} in
 \aspect. What this means is that you can't just list anything in the input
-file with entries that are unknown simply being ignored. Rather, if your input
-file contains a line setting a parameter that is unknown to something, you
+file, and expect that entries that are unknown are simply ignored.
+Rather, if your input file contains a line setting a parameter that is unknown, you
 will get an error message. Likewise, all declared parameters have a
 description of possible values associated with them -- for example, some
 parameters must be non-negative integers (the number of initial refinement
@@ -2514,6 +2514,12 @@ Finally, because parameters have been declared, you do not \textit{need} to
 specify a parameter in the input file: if a parameter isn't listed, then the
 program will simply use the default provided when declaring the parameter.
 
+\note{In cases where a parameter requires a significant amount of text, you can
+end a line in the input file with a backslash. This indicates that the
+following line will simply continue to be part of the text of the current line,
+in the same way as the C/C++ preprocessor expands lines that end in
+backslashes.}
+
 \subsubsection{Categories of parameters}
 
 The parameters that can be provided in the input file can roughly be
@@ -2551,8 +2557,9 @@ categorized into the following groups:
   plugins), and one can then specify the specifics of this model in a
   sub-subsection dedicated to this particular model.
 
-  A number of components of \aspect{} are implemented via plugins. These are,
-  together with the sections in which their parameters are declared:
+  A number of components of \aspect{} are implemented via plugins. Some of
+  these, together with the sections in which their parameters are declared, are
+  the following:
   \begin{itemize}
   \item The material model:
     Sections~\ref{parameters:Material_20model} and following.
diff --git a/doc/modules/changes.h b/doc/modules/changes.h
index a08fe05..bd89154 100644
--- a/doc/modules/changes.h
+++ b/doc/modules/changes.h
@@ -6,6 +6,11 @@
  *
  * <ol>
  *
+ * <li> New: Input files can now contain lines ending in backslashes
+ * to concatenate subsequent lines.
+ * <br>
+ * (Menno Fraters, 2014/05/19)
+ *
  * <li> New: There is a new material model called multicomponent for 
  * having an arbitrary number of compositional fields with different
  * material properties, where each compositional field represents a rock