Skip to content

Commit b3ce195

Browse files
authored
Merge pull request opencontainers#558 from Mashimiao/config-clarify-root-filesystem-path
config.md: clarify the root filesystem path
2 parents 7a36e7e + 61e2a60 commit b3ce195

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ For example, if an implementation is compliant with version 1.0.1 of the spec, i
2525
**`root`** (object, required) configures the container's root filesystem.
2626

2727
* **`path`** (string, required) Specifies the path to the root filesystem for the container.
28+
The path can be an absolute path (starting with /) or a relative path (not starting with /), which is relative to the bundle.
29+
For example (Linux), 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`.
2830
A directory MUST exist at the path declared by the field.
2931
* **`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container, defaults to false.
3032

0 commit comments

Comments
 (0)