Use updated urfave/cli to generate man pages#3637
Merged
dmcgowan merged 1 commit intocontainerd:masterfrom Sep 11, 2019
Merged
Conversation
|
Build succeeded.
|
crosbymichael
force-pushed
the
manpages
branch
from
1e6c9f1 to
990f9d1
Compare
|
Build succeeded.
|
crosbymichael
force-pushed
the
manpages
branch
from
990f9d1 to
e7db541
Compare
|
Build succeeded.
|
AkihiroSuda
reviewed
Sep 11, 2019
Member
There was a problem hiding this comment.
Can we add the same description to containerd-stress?
crosbymichael
force-pushed
the
manpages
branch
2 times, most recently
from
4df976d to
e1ed190
Compare
|
Build succeeded.
|
Member
|
For some reason the vendor check is failing with modified files when |
The climan package has a command that can be registered with any urfav cli app to generate man pages. Signed-off-by: Michael Crosby <[email protected]>
crosbymichael
force-pushed
the
manpages
branch
from
e1ed190 to
f3a5b8c
Compare
|
Build succeeded.
|
Codecov Report
@@ Coverage Diff @@
## master #3637 +/- ##
=========================================
- Coverage 42.39% 37.29% -5.1%
=========================================
Files 127 85 -42
Lines 14048 11721 -2327
=========================================
- Hits 5955 4371 -1584
+ Misses 7193 6737 -456
+ Partials 900 613 -287
Continue to review full report at Codecov.
|
Member
|
To make the Makefile target This works fine for CI because we manually enforce this with our setup scripts. I guess in that sense it is a developer dependency if they want to work on manpages? Maybe that's reasonable? |
Member
Author
|
Yes, it should be no different than today if you wanted to generate the manpages. |
estesp
approved these changes
Sep 11, 2019
Member
estesp
left a comment
estesp
left a comment
There was a problem hiding this comment.
LGTM
Not as beautiful as handcrafted, artisanal manpages, but the machines are getting better these days. It works! :)
seemethere
added a commit
to seemethere/containerd
that referenced
this pull request
Oct 8, 2019
Seems to be that docs/man/ctr.1.md and docs/man/containerd.1.md were removed in containerd#3637 and were not updated correctly in the Makefile, leading to build failures like: + make man make: *** No rule to make target `man/ctr.1', needed by `man'. Stop. Changes the gen-manpages command to be specific on which manpages are to be generated. Signed-off-by: Eli Uriegas <[email protected]>
seemethere
added a commit
to seemethere/containerd
that referenced
this pull request
Oct 11, 2019
Seems to be that docs/man/ctr.1.md and docs/man/containerd.1.md were removed in containerd#3637 and were not updated correctly in the Makefile, leading to build failures like: + make man make: *** No rule to make target `man/ctr.1', needed by `man'. Stop. Changes the gen-manpages command to be specific on which manpages are to be generated. Signed-off-by: Eli Uriegas <[email protected]> (cherry picked from commit 036db34) Signed-off-by: Eli Uriegas <[email protected]>
erikwilson
pushed a commit
to erikwilson/rancher-containerd
that referenced
this pull request
Oct 23, 2019
Seems to be that docs/man/ctr.1.md and docs/man/containerd.1.md were removed in containerd#3637 and were not updated correctly in the Makefile, leading to build failures like: + make man make: *** No rule to make target `man/ctr.1', needed by `man'. Stop. Changes the gen-manpages command to be specific on which manpages are to be generated. Signed-off-by: Eli Uriegas <[email protected]> (cherry picked from commit 036db34) Signed-off-by: Eli Uriegas <[email protected]>
tussennet
pushed a commit
to tussennet/containerd
that referenced
this pull request
Sep 11, 2020
Seems to be that docs/man/ctr.1.md and docs/man/containerd.1.md were removed in containerd#3637 and were not updated correctly in the Makefile, leading to build failures like: + make man make: *** No rule to make target `man/ctr.1', needed by `man'. Stop. Changes the gen-manpages command to be specific on which manpages are to be generated. Signed-off-by: Eli Uriegas <[email protected]>
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
5 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 will generate man pages based on the cli apps. It adds an extra command to each of the binaries that we need man pages for and it generates them in markdown format first so that we can add additional pages.