Skip to content

Commit 788db8b

Browse files
clarify some macro instructions (#385)
1 parent dc01580 commit 788db8b

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

source/WorkingPractices/inputs.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,22 @@ to the new metadata. The SSD team are also available to advise on whether an upg
8989
9090
If you have a linked LFRic Core or Jules ticket with metadata changes, you can load their metadata by adding ``-M /path/to/working_copy/rose-meta`` to the ``rose-edit`` command.
9191

92+
93+
Adding a new LFRic Metadata Section
94+
-----------------------------------
95+
96+
Due to the way lfric metadata is shared, if a new LFRic metadata section is added, then a few new files are added. A new LFRic metadata section here is defined as a new directory within an existing or new ``rose-meta`` directory. Adding a new metadata section requires:
97+
98+
* ``rose-meta/META-NAME/HEAD/rose-meta.conf``
99+
* ``rose-meta/META-NAME/vnX.Y/rose-meta.conf`` (where ``X.Y`` is the most recent released version)
100+
* ``rose-meta/META-NAME/versions.py``
101+
* A symlink from the top-level rose-meta directory to the new directory (see existing ones for examples)
102+
103+
The ``vnX.Y`` and ``HEAD`` metadata should be identical for this initial ticket, other than any import statements, which should point at vnX.Y or HEAD respectively. Other ``vnX.Y`` and ``versionAB_CD.py`` files shouldn't be modified or added (these are a snapshot of the metadata at a release).
104+
105+
If a new rose-stem app using the new metadata is also being added, then a "blank" upgrade macro will also need to be added with a ``BEFORE_TAG=vnX.Y`` and a standard ``AFTER_TAG=vnX.Y_tTTTT``. This upgrade macro will allow the new app to be updated to the Head metadata when the branch is merged to trunk. The ``rose-app.conf`` for this app will require a metadata import line of format, ``meta=META-NAME/vnX.Y``.
106+
107+
92108
How to add an upgrade macro to your branch
93109
------------------------------------------
94110

source/WorkingPractices/macros.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,9 @@ To add upgrade macros to LFRic the following steps can be followed:
123123

124124
.. code-block::
125125
126-
export CYLC_VERSION=8
126+
export CYLC_VERSION=8
127127
128-
SimSys_Scripts/lfric_macros/apply_macros.py vnXX.Y_tTTTT -a Apps -c Core -j Jules
128+
SimSys_Scripts/lfric_macros/apply_macros.py vnX.Y_tZZZZ [--apps=/path/to/apps] [--core=/path/to/core] [--jules=/path/to/jules]
129129
130130
.. important::
131131

source/WorkingPractices/metadata_guidance.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
..
44
This section will need some thought and revisiting after CA2 is completed.
55
6+
.. important::
7+
8+
Do **not** edit the existing ``vnX.Y`` metadata directories or the upgrade python files (eg ``versionab_cd.py``) as these are a snapshot of the metadata at release. Only the ``HEAD`` and ``versions.py`` files should be modified.
9+
610
Some basic guidance on Rose metadata
711
====================================
812

0 commit comments

Comments
 (0)