man: Shift examples from the README to man pages #142
Closed
Conversation
This file contains 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
You can call 'ocitools generate ...' without elevated permissions. Signed-off-by: W. Trevor King <wking@tremily.us>
If the examples are worth documenting, they're worth putting in the man pages where users who install (but don't develop) ocitools can find them. Also update the validation example to catch up with recent changes, and add a --host-specific example to advertize that feature (since folks skimming the man page quickly might expect the bare 'ocitools validate' to be host-specific). Signed-off-by: W. Trevor King <wking@tremily.us>
| $ ocitools generate | ||
| $ ocitools validate | ||
| INFO[0000] Bundle validation succeeded. | ||
| ``` | ||
|
|
||
| ## Testing OCI runtimes |
There was a problem hiding this comment.
why this example is here? shouldn't it go the man page as well?
There was a problem hiding this comment.
I guess the question is: shouldn't testruntime.sh be a part of ocitools?
|
We should have examples in man pages, but I think should also leave examples in README. |
|
On Mon, Feb 13, 2017 at 07:00:55PM -0800, Ma Shimiao wrote:
We should have examples in man pages, but I think should also leave
examples in README.
That's not very DRY, but if runtime-tools maintainers want to go that
way, they're welcome to. I'm not interested in supporting that
approach myself, so if it's a maintainer requirement, feel free to
close this PR.
|
|
DRY is good but not required. I think by now it more important to let users know how to use runtime-tools easily, just by README.md. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If the examples are worth documenting, they're worth putting in the man
pages where users who install (but don't develop) ocitools can find them.
Also update the validation example to catch up with recent changes, and add
a --host-specific example to advertize that feature (since folks skimming
the man page quickly might expect the bare 'ocitools validate' to be
host-specific).
Also change
#→$in the generate man page to show where you'relikely to need elevated permissions (you don't for
generatecalls).