add guidance for lfric_core revision (#167)

MetOffice · Apr 15, 2024 · bbe3d3f · bbe3d3f
1 parent 1db2e5a
commit bbe3d3f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/source/WorkingPractices/TestSuites/lfric_apps.rst b/source/WorkingPractices/TestSuites/lfric_apps.rst
@@ -14,6 +14,13 @@ LFRic Apps testing is run with the following commands from a working copy:
 
 -----
 
+.. important::
+
+    When specifying the lfric_core source the lfric_core revision **must** be updated in ``dependencies.sh``.
+
+    * If setting the source to an fcm URL, the mirror needs to be used and the revision can either be blank (for latest commit) or any valid revision for that branch.
+    * If setting the source to a Working Copy, the hostname needs to be provided (as Hostname:Path) and the revision must be blank.
+
 The LFRic Apps rose stem includes a range of tests to exercise all the applications
 stored in this repository, using multiple compilers, and checksum and plot tasks to
 confirm the outputs.

diff --git a/source/WorkingPractices/multi_repository.rst b/source/WorkingPractices/multi_repository.rst
@@ -64,6 +64,13 @@ code revisions are needed for testing across repositories as described above.
 Testing changes in JULES, LFRic Core, UKCA, or any other child repositories is
 as simple as running the standalone test procedures for these codebases.
 
+.. important::
+
+    When specifying an alternative source in the ``dependencies.sh`` file the revision for the source **must** be updated.
+
+    * If setting the source as an fcm URL, the mirror needs to be used and the revision can either be blank (for latest commit) or any valid revision for that branch.
+    * If setting the source as a Working Copy, the hostname needs to be provided (as Hostname:Path) and the revision must be blank.
+
 Testing the UM with other repositories
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -131,13 +138,6 @@ these paths can either be to local changes or those in the repository.
 
         More details on LFRic Apps testing are found :ref:`here<lfric_apps_test>`.
 
-
-
-.. tip::
-    Links to changes stored in fcm source control should point at the mirror
-    repository (note `jules.xm` rather than `jules.x` above). Links to local
-    changes provided to the LFRic Apps build should start with `<hostname>:`.
-
 .. note::
     If any of the testing shows up failures then there are two possible ways to
     proceed: