Merge pull request #7 from billsacks/document_xmlchange_record

document ability of xmlchange to record changes to CaseStatus
E3SM-Project · May 7, 2015 · 5e81d9b · 5e81d9b
2 parents 37362f7 + 40a386e
commit 5e81d9b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/doc/usersguide/createcase.xml b/doc/usersguide/createcase.xml
@@ -898,7 +898,9 @@ You can edit the xml files directly to change the variable
 values. However, modification of the xml variables is best
 done using <command>xmlchange</command> in the $&CASEROOT;
 directory since it performs variable error checking as part of
-changing values in the xml files. To invoke <command> xmlchange</command>:
+changing values in the xml files. <command>xmlchange</command>
+also records changes to the CaseStatus file for future reference
+and reproducibility. To invoke <command> xmlchange</command>:
 </para>
 
 <screen>

diff --git a/doc/usersguide/faq.xml b/doc/usersguide/faq.xml
@@ -305,8 +305,9 @@ possible to avoid problems running ccsm_getenv later.
 
 <para>
 CESM recommends using the xmlchange tool to modify env variables.  xmlchange
-supports error checking as part of the implementation.  Also, using xmlchange
-will decrease the chance that typographical errors will creep into the
+supports error checking as part of the implementation, and records changes to
+the CaseStatus file for future reference and reproducibility.  Also, using
+xmlchange will decrease the chance that typographical errors will creep into the
 xml files.  Conversion of the xml files to environment variables can fail
 silently with certain xml format errors.  To use xmlchange, do, for instance,
 </para>