Skip to content

Commit 7de3cb8

Browse files
committed
config: Replace "SHOULD consider" for 'rootfs' path value
SHOULD means that [1]: ... there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course. So consideration is already baked into the definition, and we can just say "SHOULD be" and warn folks whenever they use a value other than 'rootfs'. Also move this under the non-Windows conditions, because the advice they doesn't apply to Windows where the value MUST be a volume GUID path (since 2283e63, Windows: Remove Sandbox, additional tweaks, 2017-05-23, #849). [1]: https://tools.ietf.org/html/rfc2119#section-3 Signed-off-by: W. Trevor King <[email protected]>
1 parent f79b61d commit 7de3cb8

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

config.md

Lines changed: 1 addition & 1 deletion
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)