Skip to content

Commit

Permalink
bundle: Move 'rootfs' recommendation to config.md
Browse files Browse the repository at this point in the history
Anyone setting 'rootfs.path' should be aware of this advice,
regardless of whether they're the ones composing the bundle or not.

Use the RFC 2119 "SHOULD" (vs. the old lowercase "should") for this
recommendation.  The SHOULD semantics make sense and using SHOULD
avoids confusing readers ("did they mean to SHOULD this?").

Also drop the "While the name of this directory may be arbitrary"
caveat, because SHOULD already implies "but you can pick another
directory name if you want".

Note that the "MUST be present in a single directory" line which is
still in bundle.md forbids you from picking "foo/bar", "../foo", or
other paths that do not point at a direct child of the bundle
directory.  I don't like that direct-child restriction [1], but I'm
not touching it in this commit.

[1]: #469

Signed-off-by: W. Trevor King <[email protected]>
  • Loading branch information
wking committed May 18, 2017
1 parent c83b8c8 commit b46ed85
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 2 deletions.
2 changes: 0 additions & 2 deletions bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ This REQUIRED file MUST reside in the root of the bundle directory and MUST be n
See [`config.json`](config.md) for more details.

2. <a name="containerFormat02" />A directory representing the root filesystem of the container.
While the name of this directory may be arbitrary, users should consider using a conventional name, such as `rootfs`.

On Windows, for Windows Server containers, this directory is REQUIRED. For Hyper-V containers, it MUST be omitted.

On all other platforms, this field is REQUIRED.
Expand Down
1 change: 1 addition & 0 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ For example, if a configuration is compliant with version 1.1 of this specificat
**`root`** (object, REQUIRED) specifies the container's root filesystem.

* **`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. For Hyper-V Containers, this field MUST be omitted.

Expand Down

0 comments on commit b46ed85

Please sign in to comment.