Adjust filesnames to match associated JSON #126

wking · 2015-08-29T07:12:17Z

And add more links to the runtime.json specs, since #88 didn't add
any. More details and motivation for each step in the commit
messages.

wking · 2015-08-29T07:34:24Z

The last commit (d83516e) adjust the lifecycle vs. master, but as I explain in that commit message, I don't think the lifecycle explained in master makes sense. If the explicit-destroy is unpalatable, we can use just “start” (for “create and start”) and “stop” (for “stop and destroy”) to get this PR landed while we work out the container/application separation (for more on this split, see this thread).

I'm also personally in favor of allowing multiple applications per container, in which case I think we'll want something like wking/opencontainer-runtime-spec@4a87a44fa, but that's proved controversial in #107, so I'm leaving it out in the hopes that we can land this reorganization PR more quickly.

laijs · 2015-08-29T08:11:32Z

README.md

  - [Linux Specific Configuration](config-linux.md)
- [Runtime and Lifecycle](runtime.md)
+- [Host-specific Container Configuration](runtime.md)
+  - [Linux Specific Configuration](runtime-linux.md)


you have two Linux Specific Configuration one for the config-linux.md and the other for runtime-linux.md

- [Platform-independent Container Configuration](config.md) - [Linux Specific Configuration](config-linux.md) - [Host-specific Container Configuration](runtime.md) - [Linux Host-specific Configuration](runtime-linux.md)

On Sat, Aug 29, 2015 at 01:11:34AM -0700, Lai Jiangshan wrote:

Linux Specific Configuration
-- Runtime and Lifecycle
+- Host-specific Container Configuration

Linux Specific Configuration

you have two Linux Specific Configuration one for the
config-linux.md and the other for runtime-linux.md

They share the same title because they are namespaced by the
higher-level entry. To be completely specific, it would be:

Host-independent Container Configuration

Linux-specific, Host-independent Configuration

Host-specific Container Configuration

Linux-specific, Host-specific Configuration

But that seemed too wordy.

Although I suppose I should at least convert to “Linux-specific” for
consistent hyphenation.

Before this commit we had the following mapping: * config.md → config.go (config.json) * config-linux.md → config_linux.go (config.json's "linux") * runtime-config.md → runtime_config.go (runtime.json) * runtime.md → lifecycle and runtime_config.go (runtime.json's "prestart" and "poststop" hooks) * runtime-config-linux.md → runtime_config_linux.go (runtime.json's "linux") This commit: * replaces underscores with hyphens, and: * renames Go and Markdown files so: * the docs for ${X}.json are in ${X}.md * the platform-independent types for ${X}.json are in ${X}.go * the docs for ${X}.json's ${PLATFORM} section are in ${X}-${PLATFORM}.md * the platform-dependent types for ${X}.json's ${PLATFORM} section are in ${X}-${PLATFORM}.go Signed-off-by: W. Trevor King <wking@tremily.us>

Hooks are only valid in runtime.json, so we should discuss them in the runtime.json docs. I'll add appropriate links from the lifecycle docs in a bit, but linking into runtime.json is poor enough that I think it deserves its own commit. The only change here besides the copy/paste is the addition of a blank line after the Markdown headers to match the rest of the documentation. Signed-off-by: W. Trevor King <wking@tremily.us>

Just like we link to the config.json docs. Signed-off-by: W. Trevor King <wking@tremily.us>

Signed-off-by: W. Trevor King <wking@tremily.us>

It doesn't make sense to split creation into "create" and "start" while only having one "stop" command for both the application and container teardown.

To match 'Host-specific' and 'Host-independent'. Signed-off-by: W. Trevor King <wking@tremily.us>

To distinguish from the host-dependent runtime.json configuration. Signed-off-by: W. Trevor King <wking@tremily.us>

Signed-off-by: W. Trevor King <wking@tremily.us>

And add top-level headings for these files. Signed-off-by: W. Trevor King <wking@tremily.us>

This page is just about the lifecycle now. I'm not sure what the original intention was, but when this header landed in runtime.md with 5d2eb18 (*: re-org the spec, 2015-06-24) there wasn't anything beyond the lifecycle stuff in this file. Now that it's lifecycle.md and there are other files for our other content, I don't expect it to talk about anything besides the lifecycle in the future. Signed-off-by: W. Trevor King <wking@tremily.us>

wking · 2015-08-30T05:36:26Z

Rebased on the current master (mostly picking up #113), and adding some more consistent cross-linking. For example, nothing was linking to the content that landed in #113.

wking · 2015-08-31T22:08:32Z

I don't think I'm doing anything controversial here, but this large renaming is going to be difficult to rebase as other PRs land in front of it (and possibly for folks writing other PRs if this lands in front of theirs, depending on whether their work touches something I did inside a file). It would be easiest if we could get an accept/reject on this one quickly to avoid needless rebasing work. If there's anything I can do to make this easier to review, or split off smaller chunks, let me know.

laijs · 2015-09-01T00:53:56Z

I think it will be better if the pr is split into smaller ones.
I'm glad if you do the rename as the first pr. I need the patch for RUNV.

wking · 2015-09-01T01:32:12Z

On Mon, Aug 31, 2015 at 05:53:57PM -0700, Lai Jiangshan wrote:

I think it will be better if the pr is split into smaller ones.

What do you think I can split off? I'm fine with folks merging /
cherry-picking the earlier commits if there's anything later on that's
difficult to review or controversial.

laijs · 2015-09-01T01:51:33Z

Your pr changes several things:

update the lifecycle
update headers
misc
rename

I think the PR can be split into these PRs.
If you don't mind, I can take the rename part and create a new PR.

wking · 2015-09-01T02:22:24Z

On Mon, Aug 31, 2015 at 06:51:34PM -0700, Lai Jiangshan wrote:

Your pr changes several things:

update the lifecycle

update headers

misc

rename

Which one of these are commits like 4cfa584? Once the rename makes
the mapping between documentation and JSON files clear, you recognize
that things like the current hooks documentation is in the wrong place
(e.g. it's in the lifecycle docs, while it should be in the
runtime.json docs, 4cfa584). Then you realize that the runtime docs
weren't linked from anywhere, so you add c5305f9, fcd496c. Folks who
are used to having hook documentation in the lifecycle section will
probably want links to the new hook location, so you add enough of a
lifecycle overview that you can link to the hooks (8dae07a). Etc.,
etc. I'm fine splitting off smaller PRs, just tell me which commits
to put in which PRs. I could open up 11 teensy PRs, but that just
seems silly ;).

I'd recommend folks just start in with the first PR, and then LGTM (or
push back against) each commit as they go, for as far as they get.
Once the early commits get enough LGTMs, someone can merge them, which
will make it more likely for others to get deeper in the stack
(assuming reviewing something like 4cfa584 takes more than 30 seconds
;).

vbatts · 2015-10-05T18:54:42Z

going to close this for a couple of things. Some of the linking is now outdated. Also, with trying to overhaul the approach to be more "top down" a lot of this will likely get changed further.
Also, as a side note, golang file names standardly use "_", not "-". They used to not even compile with hyphens.

wking · 2015-10-05T19:24:38Z

On Mon, Oct 05, 2015 at 11:54:44AM -0700, Vincent Batts wrote:

going to close this for a couple of things.

Works for me, although I still think having runtime.md documenting
runtime.json makes sense. Now that the linking is a bit better
anyway, would a PR that made just that change be acceptable?

wking mentioned this pull request Aug 29, 2015

Support Lifecycle Hooks #20

Closed

laijs reviewed Aug 29, 2015
View reviewed changes

wking added 11 commits August 29, 2015 22:16

bundle.md: Link to the runtime.json docs

c5305f9

Just like we link to the config.json docs. Signed-off-by: W. Trevor King <wking@tremily.us>

README: Link to the runtime.json docs

fcd496c

Just like we link to the config.json docs. Signed-off-by: W. Trevor King <wking@tremily.us>

lifecycle: Add a list outlining the usual flow

8dae07a

Signed-off-by: W. Trevor King <wking@tremily.us>

lifecycle: Add an explicit container-destroy step

7d6e8b3

It doesn't make sense to split creation into "create" and "start" while only having one "stop" command for both the application and container teardown.

README: Change 'Linux Specific' -> 'Linux-specific'

1c55c3c

To match 'Host-specific' and 'Host-independent'. Signed-off-by: W. Trevor King <wking@tremily.us>

config: Mention host-independent in headings

c65526f

To distinguish from the host-dependent runtime.json configuration. Signed-off-by: W. Trevor King <wking@tremily.us>

lifecycle: Cross-link the generic and Linux-specific notes

e74f66f

Signed-off-by: W. Trevor King <wking@tremily.us>

runtime: Cross-link the generic and Linux-specific notes

07e052f

And add top-level headings for these files. Signed-off-by: W. Trevor King <wking@tremily.us>

wking force-pushed the uniform-filenames branch from da889ec to e22af5d Compare August 30, 2015 05:34

This was referenced Sep 3, 2015

state: Shift the state tree to it's own set of files #143

Closed

move the description of user ns mapping and default files to proper file #171

Merged

Docs overhaul #176

Merged

wking mentioned this pull request Sep 14, 2015

Allow to call Pre-start hooks for join-ns-spec #161

Closed

vbatts closed this Oct 5, 2015

wking mentioned this pull request Sep 18, 2016

Aggressive namespacing #567

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adjust filesnames to match associated JSON #126

Adjust filesnames to match associated JSON #126

wking commented Aug 29, 2015

wking commented Aug 29, 2015

laijs Aug 29, 2015

laijs Aug 29, 2015

wking Aug 29, 2015

wking commented Aug 30, 2015

wking commented Aug 31, 2015

laijs commented Sep 1, 2015

wking commented Sep 1, 2015

laijs commented Sep 1, 2015

wking commented Sep 1, 2015

vbatts commented Oct 5, 2015

wking commented Oct 5, 2015

Adjust filesnames to match associated JSON #126

Adjust filesnames to match associated JSON #126

Conversation

wking commented Aug 29, 2015

wking commented Aug 29, 2015

laijs Aug 29, 2015

Choose a reason for hiding this comment

laijs Aug 29, 2015

Choose a reason for hiding this comment

wking Aug 29, 2015

Choose a reason for hiding this comment

wking commented Aug 30, 2015

wking commented Aug 31, 2015

laijs commented Sep 1, 2015

wking commented Sep 1, 2015

laijs commented Sep 1, 2015

wking commented Sep 1, 2015

vbatts commented Oct 5, 2015

wking commented Oct 5, 2015