Skip to content

Commit dbfae14

Browse files
committed
bundle: DRYer root.path entry
Instead of repeating the config.md conditions, just make the linkage more clear. Now the chain is: 1. Bundles REQUIRE a config.json which is a bundle artifact. 2. If that config.json has a root.path entry (as specified in config.md), then add the referenced directory to the set of bundle artifacts. The config.md requirements include "If defined, a directory MUST exist at the path declared by the field". 3. Apply the "MUST all be present in a single directory" condition to all bundle artifacts. I don't like that direct-child restriction [1], but I'm not touching it in this commit. So these are the same requirements as before this commit, but with less redundancy and fewer words. [1]: opencontainers#469 Signed-off-by: W. Trevor King <[email protected]>
1 parent 69380b0 commit dbfae14

File tree

1 file changed

+1
-7
lines changed

1 file changed

+1
-7
lines changed

bundle.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,7 @@ This includes the following artifacts:
1414
This REQUIRED file MUST reside in the root of the bundle directory and MUST be named `config.json`.
1515
See [`config.json`](config.md) for more details.
1616

17-
2. <a name="containerFormat02" />A directory representing the root filesystem of the container.
18-
On Windows, for Windows Server containers, this directory is REQUIRED.
19-
For Hyper-V containers, it MUST be omitted.
20-
21-
On all other platforms, this field is REQUIRED.
22-
23-
If set, this directory MUST be referenced by [`root`](config.md#root) within the `config.json` file.
17+
2. <a name="containerFormat02" />container's root filesystem: the directory referenced by [`root.path`](config.md#root), if that property is set in `config.json`.
2418

2519
When supplied, while these artifacts MUST all be present in a single directory on the local filesystem, that directory itself is not part of the bundle.
2620
In other words, a tar archive of a *bundle* will have these artifacts at the root of the archive, not nested within a top-level directory.

0 commit comments

Comments
 (0)