Big man pages revamp + some --help fixes#3032
Merged
cyphar merged 4 commits intoopencontainers:masterfrom Jun 18, 2021
Merged
Conversation
This was removed from runc exec by commit f61c6e4 about 5 years ago, so it's time to remove it entirely. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Commit 52390d6 made this parameters obsoleted, but they are still shown in e.g. runc update --help output. Hide them (and maybe in 5 years we can remove them). Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
kolyshkin
force-pushed
the
man
branch
3 times, most recently
from
eceea5e to
07cdd83
Compare
kolyshkin
changed the title
Current runc man pages are ugly (no proper man page formatting) and very short (mostly just a copy-paste from the "runc <command> --help" output. They are also somewhat obsoleted as not all CLI updates were propagated to man/*. This commits makes the first step to solving this. In short: - added some more information about some options; - lots of formatting fixes; - use references to other man pages and web pages; - fix SYNOPSYS (formatting, mostly); - removed the repeated description of <container_id> from every page; - added SEE ALSO; - something else I forgot. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
mrunalp
approved these changes
Jun 17, 2021
AkihiroSuda
approved these changes
Jun 18, 2021
Member
AkihiroSuda
left a comment
AkihiroSuda
left a comment
There was a problem hiding this comment.
LGTM
Do we want to merge this before v1.0 GA or after?
(I guess it is safe to merge before v1.0 GA)
Member
|
We can merge it without issue -- the vote (and release) is on the specific PR commit so this won't be in the 1.0 GA. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Current runc man pages are ugly (no proper man page formatting)
and very short (mostly just a copy-paste from the
runc <command> --helpoutput. They are also somewhat obsoleted as not all CLI updates
were propagated to
man/*.This commits makes the first step to solving this.
In short:
TODO: remove FIXME from--work-pathdescription as soon as PR #3029 is merged.Also, some minor fixes to
runc * --help.Here's some before/after comparison:
