README: Punt detailed command description to the man pages #47
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This makes it easier to get a project overview from the README, and avoids the tedium of keeping parallel sets of detailed docs up to date. Signed-off-by: W. Trevor King <[email protected]>
Also adjust the copy of this text in the README. I've left the reference-style links out of the man page, since go-md2man doesn't seem to be able to handle them, and instead creates troff with just the link targets: \[la]man/ocitools-generate.1.md\[ra] generates a \[la]https://github.com/opencontainers/runtime-spec/blob/master/config.md\[ra] for an ... Signed-off-by: W. Trevor King <[email protected]>
wking
force-pushed
the
readme-link-man-pages
branch
from
e155b44 to
bb11739
Compare
Member
|
It looks much better. LGTM |
Contributor
Author
|
On Wed, Apr 27, 2016 at 11:55:42PM -0700, 梁辰晔 (Liang Chenye) wrote:
“TODO: We can add the runtime test description to the `Testing OCI
runtimes` part just like what you to do generete and validate.”
I think it would be better to make test_runtime.sh a first-class
citizen (‘ocitools certify’?) with a man page and everything. But
that seemed out of scope for this PR ;).
|
Member
|
Yes. And we need to discuss with @zenlinTechnofreak about his PR and his busy these day aroud. |
Contributor
|
@wking Agree that we need to convert the script into a first class option. Just needs to be done :) |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes it easier to get a project overview from the README, and
avoids the tedium of keeping parallel sets of detailed docs up to
date.