Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/oci-image-tool/man: Document multiple --ref for 'validate' #269

Merged
merged 1 commit into from
Sep 7, 2016

Conversation

wking
Copy link
Contributor

@wking wking commented Sep 7, 2016

Catch up with 6ca74be (cmd/oci-image-tool: support multiple --ref, 2016-09-06, #265).

While I'm touching it, reformat this entry to one line per sentance per the README's Markdown style section.

Catch up with 6ca74be (cmd/oci-image-tool: support multiple --ref,
2016-09-06, opencontainers#265).

While I'm touching it, reformat this entry to one line per sentance
per the README's "Markdown style" section.

Signed-off-by: W. Trevor King <[email protected]>
@wking
Copy link
Contributor Author

wking commented Sep 7, 2016

On Tue, Sep 06, 2016 at 10:07:49PM -0700, W. Trevor King wrote:

While I'm touching it, reformat this entry to one line per sentance
per the README's Markdown style section.

Although it appears go-md2man does not actually mark up these
definition lists:

$ go-md2man -in cmd/oci-image-tool/man/oci-image-tool-validate.1.md -out /dev/stdout

.PP
\fB--ref\fP NAME
The reference to validate (should point to a manifest).
Can be specified multiple times to validate multiple references.
\fB\fCNAME\fR must be present in the \fB\fCrefs\fR subdirectory of the image.
Defaults to \fB\fCv1.0\fR&.
Only applicable if type is image or imageLayout.

I'm not really sure what the plan is here. I'd be in favor of
switching to AsciiDoc or other man generator with a bit more polish
1.

@runcom
Copy link
Member

runcom commented Sep 7, 2016

LGTM (IANAM)

@jonboulle
Copy link
Contributor

jonboulle commented Sep 7, 2016

lgtm

Approved with PullApprove

@philips
Copy link
Contributor

philips commented Sep 7, 2016

LGTM

Approved with PullApprove

@jonboulle jonboulle merged commit d3cfb99 into opencontainers:master Sep 7, 2016
@wking wking deleted the man-validate-multiple-refs branch September 8, 2016 04:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants