Skip to content

Commit 0b2c1d6

Browse files
committed
update script description
Signed-off-by: Taeseung Sohn <taeseung.sohn@tier4.jp>
1 parent 6242fa5 commit 0b2c1d6

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

.github/scripts/sync_params.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@
99
1010
Overview
1111
--------
12-
Each variant file is a copy of an upstream ``*.param.yaml`` with three additions:
13-
12+
Each variant file is a copy of an upstream ``*.param.yaml`` with two default additions:
1413
1. **Header** — workflow-managed comment block that records the source GitHub URL
1514
(pinned to the last-modified commit SHA of that file).
1615
2. **Override markers** — leaf fields annotated with ``# {OVERRIDE}`` or
1716
``# {OVERRIDE: reason}`` retain their local values across syncs. All other
1817
fields are overwritten from the upstream source.
19-
3. **Embedded original** — the full upstream content is appended as a comment
20-
block (``# ###### ORIGINAL (DO NOT EDIT) ######``) so that any upstream change
21-
to an overridden field is visible in the diff of the generated sync PR.
18+
19+
An optional **Embedded original** footer may also be appended as a comment block
20+
(``# ###### ORIGINAL (DO NOT EDIT) ######``) when updated with `--footer`,
21+
so that upstream changes to overridden fields are visible in generated diffs.
2222
2323
Usage
2424
-----

0 commit comments

Comments
 (0)