mirror of
https://github.com/containers/podman.git
synced 2026-03-13 08:01:19 +08:00
[CI:DOCS] Restore man page cross-checker
Somewhere in the CIv2 migration we lost the man page vs --help
cross-checker. Add it back, by adding it into the man-page-check
Makefile target; this is part of 'make validate', which is run
in CI even on CI:DOCS PRs.
As happens when CI doesn't run, things broke. Man pages got out
of sync with --help. This PR:
1) Fixes hack/xref-helpmsgs-manpages to deal with the new
"Options" (instead of "Flags") form of podman help. #8034
did part of that, but one of my review comments was
accidentally left out.
2) Fixes hack/xref-helpmsgs-manpages to deal with the new
option syntax in man pages, post- #8292, in which each
option is preceded by four hashes so as to make them
HTML <h4> elements with named anchors.
3) Fixes man pages that #8292 accidentally missed.
4) Adds man page entries for two flags that got added
to podman but not documented (pod create --network-alias,
play kube --log-driver)
Fixes: #8296
Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
5
Makefile
5
Makefile
@@ -392,10 +392,6 @@ docdir:
|
||||
.PHONY: docs
|
||||
docs: $(MANPAGES) ## Generate documentation
|
||||
|
||||
.PHONE: xref_helpmsgs_manpages
|
||||
xref_helpmsgs_manpages:
|
||||
./hack/xref-helpmsgs-manpages
|
||||
|
||||
install-podman-remote-%-docs: podman-remote docs $(MANPAGES)
|
||||
rm -rf docs/build/remote
|
||||
mkdir -p docs/build/remote
|
||||
@@ -405,6 +401,7 @@ install-podman-remote-%-docs: podman-remote docs $(MANPAGES)
|
||||
.PHONY: man-page-check
|
||||
man-page-check:
|
||||
hack/man-page-checker
|
||||
hack/xref-helpmsgs-manpages
|
||||
|
||||
.PHONY: swagger-check
|
||||
swagger-check:
|
||||
|
||||
Reference in New Issue
Block a user