Skip to content

Commit fae0d09

Browse files
author
Mrunal Patel
authored
Merge pull request #839 from wking/move-rootfs-recommendation-to-config
bundle: Move 'rootfs' recommendation to config.md
2 parents c83b8c8 + b46ed85 commit fae0d09

File tree

2 files changed

+1
-2
lines changed

2 files changed

+1
-2
lines changed

bundle.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ This REQUIRED file MUST reside in the root of the bundle directory and MUST be n
1515
See [`config.json`](config.md) for more details.
1616

1717
2. <a name="containerFormat02" />A directory representing the root filesystem of the container.
18-
While the name of this directory may be arbitrary, users should consider using a conventional name, such as `rootfs`.
19-
2018
On Windows, for Windows Server containers, this directory is REQUIRED. For Hyper-V containers, it MUST be omitted.
2119

2220
On all other platforms, this field is REQUIRED.

config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ For example, if a configuration is compliant with version 1.1 of this specificat
2929
**`root`** (object, REQUIRED) specifies the container's root filesystem.
3030

3131
* **`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.
32+
Users SHOULD consider using a conventional name, such as `rootfs`.
3233

3334
On Windows, for Windows Server Containers, this field is REQUIRED. For Hyper-V Containers, this field MUST be omitted.
3435

0 commit comments

Comments
 (0)