search

wking / oci-command-line-api

A command-line API specification for opencontainers/specs
Apache License 2.0
2 stars 3 forks source link

Clarity for commands vs global options #8

Closed mikebrow closed 8 years ago

mikebrow commented 8 years ago

While reviewing the global options section in runtime.md, it seemed additional clarity was needed for the command and global options requirements. Discussed and worked on wording with @wking via private IRC. Also adds uppercase RFC 2119 words for this section.

With regard to the statement Command names MUST not start with hyphens, the rationale behind this decision is to "distinguish unrecognized commands from unrecognized options, and because we are "requiring runtimes to fail-fast for unrecognized commands" [1,2].

[1] https://github.com/wking/oci-command-line-api/pull/8/files#r46898167 [2] https://github.com/wking/oci-command-line-api/commit/527f3c629a7224144c1e5e41a8a197fe0eb5bc00#commitcomment-14835617

Signed-off-by: Mike Brown brownwm@us.ibm.com

wking commented 8 years ago

This looks like a good step forward :). I left a few comments inline, but feel free to push back if the suggestions don't seem sound.

mikebrow commented 8 years ago

Good comments. I've addressed them. I've also added use of upper case MAY where you also used upper case on your wip branch.

Cheers!

wking commented 8 years ago

Just checking up on outstanding PRs, and thought I'd file a note here saying that we're a day out since 2b084a3 was pushed 1 and I've LGTMed it 2. I'll land it after the two-worday window wraps up tomorrow unless anyone else raises issues with it.