config.md: clarify the root filesystem path #558
Conversation
config.md
Outdated
| **`root`** (object, required) configures the container's root filesystem. | ||
|
|
||
| * **`path`** (string, required) Specifies the path to the root filesystem for the container. | ||
| The path MUST be an a relative path (not starting with /), which is relative to the bundle. e.g. |
There was a problem hiding this comment.
However, I think it does make sense to clarify the base from which relative paths are interpreted, in cases where someone does use a relative path here. I'd recommend doing that with a stand-alone section early in this file, so other relative-path locations can benefit from it. That would allow us to relax some absolute-path requirements we're still carrying around (e.g. for namespace paths).
There was a problem hiding this comment.
Acutally, I think no matter absolute path or relative path is OK.
I just want to clarify which kind of value can be set to path.
Mashimiao
force-pushed
the
config-clarify-root-filesystem-path
branch
from
3f1763f to
b7f7912
Compare
config.md
Outdated
|
|
||
| * **`path`** (string, required) Specifies the path to the root filesystem for the container. | ||
| The path can be an absolute path (starting with /) or a relative path (not starting with /), which is relative to the bundle. e.g. | ||
| If the absolute path of root filesystem is /to/bundle/rootfs, we can set it or rootfs to`path. |
There was a problem hiding this comment.
looks like a dangling backtick `
and i'm not sure i follow the "we can set it or rootfs to path" sentence.
There was a problem hiding this comment.
On Thu, Sep 08, 2016 at 07:00:35AM -0700, Vincent Batts wrote:
@@ -25,6 +25,8 @@ For example, if an implementation is compliant with version 1.0.1 of the spec, i
root(object, required) configures the container's root filesystem.
path(string, required) Specifies the path to the root filesystem for the container.
- The path can be an absolute path (starting with /) or a relative path (not starting with /), which is relative to the bundle. e.g.
- If the absolute path of root filesystem is /to/bundle/rootfs, we can set it or rootfs to`path.
looks like a dangling backtick `
and i'm not sure i follow the "we can set it or rootfs to path" sentence.
How about:
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.
There was a problem hiding this comment.
On 09/09/2016 12:39 AM, W. Trevor King wrote:
How about: For example, with a bundle at
/to/bundleand a root filesystem at/to/bundle/rootfs, thepathvalue can be either/to/bundle/rootfsorrootfs.
It looks better than mine. Fixed.
Mashimiao
force-pushed
the
config-clarify-root-filesystem-path
branch
from
b7f7912 to
3a8696d
Compare
config.md
Outdated
|
|
||
| * **`path`** (string, required) Specifies the path to the root filesystem for the container. | ||
| The path can be an absolute path (starting with /) or a relative path (not starting with /), which is relative to the bundle. | ||
| 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`. |
There was a problem hiding this comment.
The example should be explicit for *unix since other platforms like windows don't take / as root.
Signed-off-by: Ma Shimiao <[email protected]>
Mashimiao
force-pushed
the
config-clarify-root-filesystem-path
branch
from
3a8696d to
61e2a60
Compare
|
any comments? |
|
LGTM |
|
LGTM |
4 participants
Signed-off-by: Ma Shimiao [email protected]