Skip to content

Commit 8e2c7dc

Browse files
committed
Update edf.md
1 parent 11a6103 commit 8e2c7dc

File tree

1 file changed

+3
-3
lines changed
  • docs/software/container-engine

1 file changed

+3
-3
lines changed

docs/software/container-engine/edf.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,10 +183,10 @@ OCI-like annotations for the container. For more details, refer to the [Annotati
183183

184184
Environment variable expansion allows for dynamic substitution of environment variable values within the EDF (Environment Definition File). This capability applies across all configuration parameters in the EDF, providing flexibility in defining container environments.
185185

186-
* *Syntax*. Use ${VAR} to reference an environment variable VAR. The variable's value is resolved from the combined environment, which includes variables defined in the host and the container image, the later taking precedence.
187-
* *Scope*. Variable expansion is supported across all EDF parameters. This includes EDF’s parameters like mounts, workdir, image, etc. For example, ${SCRATCH} can be used in mounts to reference a directory path.
186+
* *Syntax*. Use `${VAR}` to reference an environment variable `VAR`. The variable's value is resolved from the combined environment, which includes variables defined in the host and the container image, the later taking precedence.
187+
* *Scope*. Variable expansion is supported across all EDF parameters. This includes EDF’s parameters like mounts, workdir, image, etc. For example, `${SCRATCH}` can be used in mounts to reference a directory path.
188188
* *Undefined Variables*. Referencing an undefined variable results in an error. To safely handle undefined variables, you can use the syntax ${VAR:-}, which evaluates to an empty string if VAR is undefined.
189-
* *Preventing Expansion*. To prevent expansion, use double dollar signs $$. For example, $${VAR} will render as the literal string ${VAR}.
189+
* *Preventing Expansion*. To prevent expansion, use double dollar signs $$. For example, `$${VAR}` will render as the literal string `${VAR}`.
190190
* *Limitations*
191191
* Variables defined within the `[env]` EDF table cannot reference other entries from `[env]` tables in the same or other EDF files (e.g. the ones entered as base environments). Therefore, only environment variables from the host can be referenced.
192192
* *Environment Variable Resolution Order*. The environment variables in containers are set based on the following order:

0 commit comments

Comments
 (0)