diff options
| author | Ed Santiago <santiago@redhat.com> | 2020-03-11 14:59:25 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2020-03-18 11:03:26 -0600 |
| commit | 81005f463ef0de79b4b94bb2b78f3ac0791b2703 (patch) | |
| tree | 09376c674f471a704fe0feae20b4e20dd31ec5b3 /Makefile | |
| parent | d9eb078e2a1cff73461f285924ab1ab8699e9bca (diff) | |
| download | podman-81005f463ef0de79b4b94bb2b78f3ac0791b2703.tar.gz podman-81005f463ef0de79b4b94bb2b78f3ac0791b2703.tar.bz2 podman-81005f463ef0de79b4b94bb2b78f3ac0791b2703.zip | |
New test: man page cross-ref against --help
New hack/xref-helpmsgs-manpages script, added to CI 'gate'
task, runs 'podman [subcommand] --help' and cross-references
against man pages in docs/source/markdown/podman*.1.md
See #5453 and #5460 for instances of the problems the
script has found.
The careful reader will find an alarming number of special-case
bypasses. These are a tradeoff I am making: to get perfect
coverage with no handwaving, it would be necessary to make
drastic changes to some man pages, and I believe those would
be counterproductive.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -383,6 +383,10 @@ docdir: .PHONY: docs docs: .install.md2man docdir $(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 |