Skip to content

Commit 69380b0

Browse files
author
Mrunal Patel
authored
Merge pull request opencontainers#847 from wking/no-should-consider
config: Replace "SHOULD consider" for 'rootfs' path value
2 parents a9bdd59 + 7de3cb8 commit 69380b0

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ For all platform-specific configuration values, the scope defined below in the [
3030

3131
* **`path`** (string, OPTIONAL) Specifies the path to the root filesystem for the container.
3232
The path is either an absolute path or a relative path to the bundle.
33-
Users SHOULD consider using a conventional name, such as `rootfs`.
3433

3534
* On Windows, for Windows Server Containers, this field is REQUIRED and MUST be specified as a [volume GUID path][naming-a-volume].
3635
For Hyper-V Containers, this field MUST be omitted.
3736
* On all other platforms, this field is REQUIRED.
37+
The value SHOULD be the conventional `rootfs`.
3838
* On Linux, for example, with a bundle at `/to/bundle` and a root filesystem at `/to/bundle/rootfs`, the `path` value can be either `/to/bundle/rootfs` or `rootfs`.
3939

4040
If defined, a directory MUST exist at the path declared by the field.

0 commit comments

Comments
 (0)