Skip to content

Commit

Permalink
doc: document mustache templates in job environment
Browse files Browse the repository at this point in the history
Problem: The ability to use mustache templates for environment
variables in job submission commands is not documented.

Document it in the ENV RULES section of the submission cli manpages.
grondo committed Jan 6, 2025
1 parent c2312c4 commit 9cb6099
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion doc/man1/common/job-env-rules.rst
Original file line number Diff line number Diff line change
@@ -31,8 +31,13 @@ via a set of *RULE* expressions. The currently supported rules are
* Advanced parameter substitution is not allowed, e.g. ``${var:-foo}``
will raise an error.

``VAL`` may also contain a mustache template, in which case the template
will be substituted in the job shell with the corresponding value before
launching job tasks. See `MUSTACHE TEMPLATES`_ for more information.

Examples:
``PATH=/bin``, ``PATH=$PATH:/bin``, ``FOO=${BAR}something``
``PATH=/bin``, ``PATH=$PATH:/bin``, ``FOO=${BAR}something``,
``PATH=${PATH}:/{{tmpdir}}/bin``

* Otherwise, the rule is considered a pattern from which to match
variables from the process environment if they do not exist in

0 comments on commit 9cb6099

Please sign in to comment.