diff options
| author | Ed Santiago <santiago@redhat.com> | 2020-11-10 12:57:53 -0700 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2020-11-11 08:31:30 -0700 |
| commit | b0601cb34ada6b0d4f29bf33221d1e8584ee50ad (patch) | |
| tree | 4edfdd9f3937c6f52cede254a5860c429c842eba /Makefile | |
| parent | 1952420e88bad3f602ab78ea140db9872acdba2b (diff) | |
| download | podman-b0601cb34ada6b0d4f29bf33221d1e8584ee50ad.tar.gz podman-b0601cb34ada6b0d4f29bf33221d1e8584ee50ad.tar.bz2 podman-b0601cb34ada6b0d4f29bf33221d1e8584ee50ad.zip | |
[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>
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 5 |
1 files changed, 1 insertions, 4 deletions
@@ -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: |