-
Notifications
You must be signed in to change notification settings - Fork 142
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
man: Shift examples from the README to man pages #142
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why this example is here? shouldn't it go the man page as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the question is: shouldn't testruntime.sh be a part of ocitools?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
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
generate
calls).