Skip to content

Commit adfea36

Browse files
committed
docs: correct the parameter-regeneration guidance in contributing
Both passages predated the build-time generation command and still said reconfigure; a plain rebuild regenerates automatically (the command is ninja-tracked against toolchain/mfc/params/), and only adding a new file there needs a reconfigure. Flagged by Copilot review on #1556.
1 parent 563f776 commit adfea36

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

docs/documentation/contributing.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,9 @@ If your check enforces a physics constraint, also add a `PHYSICS_DOCS` entry (se
318318
Scalar declarations, GPU declare lines, Doxygen descriptions, and namelist bindings are
319319
auto-generated at build time (ninja-tracked custom command) from the `TYPED_DECLS` and `FORTRAN_ARRAY_DIMS`
320320
tables in `toolchain/mfc/params/definitions.py`. For a plain scalar registered with
321-
`_r()` / `_nv()` above, no manual Fortran edit is needed — reconfigure (`./mfc.sh build`)
322-
and the generated include in `m_global_parameters_common.fpp` (compiled per target) is updated
323-
automatically.
321+
`_r()` / `_nv()` above, no manual Fortran edit is needed — the next build regenerates the
322+
include in `m_global_parameters_common.fpp` (compiled per target) automatically: the
323+
generation command is ninja-tracked against every file under `toolchain/mfc/params/`.
324324

325325
Still manual (not auto-generated):
326326

@@ -333,8 +333,9 @@ Still manual (not auto-generated):
333333
include)
334334
- `CASE_OPT_EXTRA_LINES` in `toolchain/mfc/params/generators/fortran_gen.py` for case-optimization constants
335335

336-
After editing any generator or table, force regen by reconfiguring (`./mfc.sh build`) —
337-
cached builds compile stale includes.
336+
Editing any existing file under `toolchain/mfc/params/` (tables or generators) triggers
337+
regeneration on the next build automatically. Only *adding a new file* there requires one
338+
reconfigure — the dependency list is globbed at configure time.
338339

339340
**Step 6: Use in Fortran code**
340341

0 commit comments

Comments
 (0)