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
Use updated urfave/cli to generate man pages #3637
Conversation
Build succeeded.
|
1e6c9f1
to
990f9d1
Compare
Build succeeded.
|
990f9d1
to
e7db541
Compare
Build succeeded.
|
ctr is an unsupported debug and administrative client for interacting | ||
with the containerd daemon. Because it is unsupported, the commands, | ||
options, and operations are not guaranteed to be backward compatible or | ||
stable from release to release of the containerd project.` |
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.
Can we add the same description to containerd-stress
?
4df976d
to
e1ed190
Compare
Build succeeded.
|
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 <crosbymichael@gmail.com>
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.
|
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? |
Yes, it should be no different than today if you wanted to generate the manpages. |
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.
LGTM
Not as beautiful as handcrafted, artisanal manpages, but the machines are getting better these days. It works! :)
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.
LGTM
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 <eli.uriegas@docker.com>
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 <eli.uriegas@docker.com> (cherry picked from commit 036db34) Signed-off-by: Eli Uriegas <eli.uriegas@docker.com>
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 <eli.uriegas@docker.com> (cherry picked from commit 036db34) Signed-off-by: Eli Uriegas <eli.uriegas@docker.com>
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 <eli.uriegas@docker.com>
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.