Skip to content

Commit 0bb69f3

Browse files
committed
Bump up type and default values to the header list for EDF entries
1 parent b388d37 commit 0bb69f3

File tree

1 file changed

+24
-8
lines changed
  • docs/software/container-engine

1 file changed

+24
-8
lines changed

docs/software/container-engine/edf.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ If not specified, the default value is an empty value of the corresponding type.
99

1010
### `base_environment`
1111

12-
(ARRAY or STRING) Ordered list of EDFs that this file inherits from. Parameters from listed environments are evaluated sequentially. Supports up to 10 levels of recursion.
12+
* Type: array or string
13+
14+
Ordered list of EDFs that this file inherits from. Parameters from listed environments are evaluated sequentially. Supports up to 10 levels of recursion.
1315

1416
!!! example
1517
* Single environment inheritance:
@@ -29,7 +31,9 @@ If not specified, the default value is an empty value of the corresponding type.
2931

3032
### `image`
3133

32-
(STRING) The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
34+
* Type: string
35+
36+
The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
3337

3438
!!! example
3539
* Reference of Ubuntu image in the Docker Hub registry (default registry)
@@ -66,7 +70,10 @@ If not specified, the default value is an empty value of the corresponding type.
6670

6771
### `workdir`
6872

69-
(STRING) Initial working directory when the container starts. Default: inherited from image.
73+
* Type: string
74+
* Default: inherited from image
75+
76+
Initial working directory when the container starts.
7077

7178
!!! example
7279
* Workdir pointing to a user defined project path 
@@ -80,7 +87,10 @@ If not specified, the default value is an empty value of the corresponding type.
8087

8188
### `entrypoint`
8289

83-
(BOOL) If true, run the entrypoint from the container image. Default: true.
90+
* Type: bool
91+
* Default: `true`
92+
93+
If true, run the entrypoint from the container image.
8494

8595
!!! example
8696
```toml
@@ -89,7 +99,10 @@ If not specified, the default value is an empty value of the corresponding type.
8999

90100
### `writable`
91101

92-
(BOOL) If false, the container filesystem is read-only. Default: true.
102+
* Type: bool
103+
* Type: `true`
104+
105+
If false, the container filesystem is read-only.
93106

94107
!!! example
95108
```toml
@@ -98,7 +111,9 @@ If not specified, the default value is an empty value of the corresponding type.
98111

99112
### `mounts`
100113

101-
(ARRAY) List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
114+
* Type: array
115+
116+
List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
102117

103118
!!! example
104119
* Literal fixed mount map
@@ -124,7 +139,9 @@ If not specified, the default value is an empty value of the corresponding type.
124139

125140
### `env`
126141

127-
Environment variables to set in the container. Empty string values will unset the variable. Default: inherited from the host and the image.
142+
* Default: inherited from the host and the image
143+
144+
Environment variables to set in the container. Empty string values will unset the variable.
128145

129146
!!! example
130147
* Basic `env` block
@@ -152,7 +169,6 @@ Environment variables to set in the container. Empty string values will unset th
152169
OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
153170

154171
!!! example
155-
156172
* Disabling the CXI hook
157173
```toml
158174
[annotations]

0 commit comments

Comments
 (0)