Rewrite mounts description in config.md by hqhq · Pull Request #443 · opencontainers/runtime-spec

hqhq · 2016-05-23T07:06:24Z

Also apply one sentence per line rule for list items.

Signed-off-by: Qiang Huang h.huangqiang@huawei.com

wking · 2016-05-23T16:33:22Z

On Mon, May 23, 2016 at 12:06:27AM -0700, Qiang Huang wrote:

Apple one sentence per line rule

“Apple” → “Apply”.

And I'm not sure there's consensus about whether the rule applies to
list items. I've been using single-sentence-lines in list items, but
unless there is a consensus it's probably not worth changing existing
instances unless you're also tweaking the content.

wking · 2016-05-23T16:34:30Z

-* **`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container. Defaults to false.
+* **`path`** (string, required) Specifies the path to the root filesystem for the container.
+ A directory MUST exist at the path declared by the field.
+* **`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container, defaults to false.


I liked “Defaults to false” better as its own sentence, but I expect folks will get the idea either way ;).

And defaults are a general enough idea that it may make more sense to mark them up (e.g. “readonly (bool, default: false) If true, then …”). So settings would either be required or have a default value.

I liked “Defaults to false” better as its own sentence
I think it makes sense to combine them in one sentence, and it looks simpler, I'll change if more people think we should keep its own sentence.
And defaults are a general enough idea that it may make more sense to mark them up (e.g. “readonly (bool, default: false) If true, then …”). So settings would either be required or have a default value.
Since it's a general change for all such defaults usage in runtime-spec, I'll leave it as a separate discussion if needed.

hqhq · 2016-05-31T11:28:24Z

Updated.

wking · 2016-05-31T18:10:34Z

1895e07 looks good to me (with the exception of the default issue
1, and I'm fine spinning that out into a separate discussion 2).
I like your new, specific commit-summary a lot more too :).

Also apply one sentence per line rule for list items. Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>

wking · 2016-07-22T06:21:09Z

On Tue, May 31, 2016 at 11:10:29AM -0700, W. Trevor King wrote:

1895e07 looks good to me (with the exception of the default issue
1, and I'm fine spinning that out into a separate discussion [2]).

Is there any chance of this landing soon? I want to extend the spec
to talk about the ‘bind’ type and ‘rbind’ options 1, neither of
which are covered by the mount(8) FILESYSTEM-* MOUNT OPTIONS sections.
They are covered as long options in mount(8), but I think we need
some wording around them (and maybe --make-shared, --make-slave,
--make-rshared, etc.?), and I don't want to workup a PR for that
before we've dropped the Arch wiki as a lower layer of this spec :p.

hqhq · 2016-07-22T06:40:58Z

Rebased, ping @vbatts @mrunalp @crosbymichael

wking · 2016-07-22T06:57:22Z

On Thu, Jul 21, 2016 at 11:40:59PM -0700, Qiang Huang wrote:

Rebased…

1895e07 → 0e8e069 looks fine to me. Besides the context changes,
there's some ‘:’ → ‘,’ and a sentence break that look minor to me.

hqhq · 2016-07-22T07:13:28Z

@wking I consisted some ':' and ',' usage.

wking · 2016-07-22T16:13:08Z

On Fri, Jul 22, 2016 at 12:13:29AM -0700, Qiang Huang wrote:

@wking I consisted some ':' and ',' usage.

0e8e069 → 1752ce8 looks good to me.

See [1,2]. [1]: opencontainers/runtime-spec#443 (comment) [2]: opencontainers/runtime-tools#119 (comment)

vbatts · 2016-07-23T12:55:12Z

LGTM

crosbymichael · 2016-07-25T15:38:47Z

LGTM

See [1,2]. [1]: opencontainers/runtime-spec#443 (comment) [2]: opencontainers/runtime-tools#119 (comment)

wking reviewed May 23, 2016
View reviewed changes

hqhq force-pushed the hq_config_new_line branch from 23fa592 to 1895e07Compare May 31, 2016 11:27

hqhq changed the title ~~Some changes in config.md~~Rewrite mounts description in config.mdMay 31, 2016

Rewrite mounts description in config.md
1752ce8
Also apply one sentence per line rule for list items. Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>

hqhq force-pushed the hq_config_new_line branch from 1895e07 to 0e8e069Compare July 22, 2016 06:39

hqhq force-pushed the hq_config_new_line branch from 0e8e069 to 1752ce8Compare July 22, 2016 07:12

wking added a commit to wking/ccon that referenced this pull request Jul 23, 2016
WIP: ccon-oci: (r)bind handling
e867fc3
See [1,2]. [1]: opencontainers/runtime-spec#443 (comment) [2]: opencontainers/runtime-tools#119 (comment)

crosbymichael merged commit eccaa08 into opencontainers:masterJul 25, 2016

hqhq deleted the hq_config_new_line branch July 26, 2016 01:24

wking mentioned this pull request Aug 13, 2016
config: Document 'recursive' and 'bind' mount options extensions #530
Closed

This was referenced Nov 4, 2016
[Config] Make mount options format per-platform #439
Closed
config: Make 'process.args' optional #620
Closed

wking added a commit to wking/ccon that referenced this pull request Feb 26, 2018
WIP: ccon-oci: (r)bind handling
a50a751
See [1,2]. [1]: opencontainers/runtime-spec#443 (comment) [2]: opencontainers/runtime-tools#119 (comment)

Navigation Menu

Uh oh!

Rewrite mounts description in config.md - #443

Rewrite mounts description in config.md#443
crosbymichael merged 1 commit into
opencontainers:masterfrom
hqhq:hq_config_new_line

hqhq commented May 23, 2016•
edited
Loading

Uh oh!

wking commented May 23, 2016

Uh oh!

wkingMay 23, 2016

Uh oh!

wkingMay 23, 2016

Uh oh!

hqhqMay 31, 2016

Uh oh!

hqhq commented May 31, 2016

Uh oh!

wking commented May 31, 2016

Uh oh!

wking commented Jul 22, 2016

Uh oh!

hqhq commented Jul 22, 2016

Uh oh!

wking commented Jul 22, 2016

Uh oh!

hqhq commented Jul 22, 2016

Uh oh!

wking commented Jul 22, 2016

Uh oh!

vbatts commented Jul 23, 2016•
edited by caniszczyk
Loading

Uh oh!

crosbymichael commented Jul 25, 2016•
edited
Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

hqhq commented May 23, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wking commented May 23, 2016

Uh oh!

wkingMay 23, 2016

Choose a reason for hiding this comment

Uh oh!

wkingMay 23, 2016

Choose a reason for hiding this comment

Uh oh!

hqhqMay 31, 2016

Choose a reason for hiding this comment

Uh oh!

hqhq commented May 31, 2016

Uh oh!

wking commented May 31, 2016

Uh oh!

wking commented Jul 22, 2016

Uh oh!

hqhq commented Jul 22, 2016

Uh oh!

wking commented Jul 22, 2016

Uh oh!

hqhq commented Jul 22, 2016

Uh oh!

wking commented Jul 22, 2016

Uh oh!

vbatts commented Jul 23, 2016• edited by caniszczyk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

crosbymichael commented Jul 25, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hqhq commented May 23, 2016•
edited
Loading

vbatts commented Jul 23, 2016•
edited by caniszczyk
Loading

crosbymichael commented Jul 25, 2016•
edited
Loading