From 7de3cb814da69452d3e1389fdab596268b03bdba Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Tue, 23 May 2017 11:57:12 -0700 Subject: [PATCH] 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 --- config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.md b/config.md index 78de158cf..2575a3c96 100644 --- a/config.md +++ b/config.md @@ -30,11 +30,11 @@ For all platform-specific configuration values, the scope defined below in the [ * **`path`** (string, OPTIONAL) Specifies the path to the root filesystem for the container. The path is either an absolute path or a relative path to the bundle. - Users SHOULD consider using a conventional name, such as `rootfs`. * On Windows, for Windows Server Containers, this field is REQUIRED and MUST be specified as a [volume GUID path][naming-a-volume]. For Hyper-V Containers, this field MUST be omitted. * On all other platforms, this field is REQUIRED. + The value SHOULD be the conventional `rootfs`. * 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`. If defined, a directory MUST exist at the path declared by the field.