From 40a386e80c87c7d5693fb54f357e2ce7ca3e4b37 Mon Sep 17 00:00:00 2001 From: Bill Sacks Date: Thu, 7 May 2015 06:11:56 -0600 Subject: [PATCH] document ability of xmlchange to record changes to CaseStatus --- doc/usersguide/createcase.xml | 4 +++- doc/usersguide/faq.xml | 5 +++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/usersguide/createcase.xml b/doc/usersguide/createcase.xml index 616b129c7abb..9543f8b67be4 100644 --- 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 xmlchange in the $&CASEROOT; directory since it performs variable error checking as part of -changing values in the xml files. To invoke xmlchange: +changing values in the xml files. xmlchange +also records changes to the CaseStatus file for future reference +and reproducibility. To invoke xmlchange: diff --git a/doc/usersguide/faq.xml b/doc/usersguide/faq.xml index 63ba977e8392..c0936de8c4f1 100644 --- a/doc/usersguide/faq.xml +++ b/doc/usersguide/faq.xml @@ -305,8 +305,9 @@ possible to avoid problems running ccsm_getenv later. 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,