summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-search.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2021-11-10 08:44:44 -0700
committerEd Santiago <santiago@redhat.com>2021-11-10 09:03:40 -0700
commit6236be4ff9ec706926d415a1cb4305ebf49048a7 (patch)
treebaff892a3c40e8dce73563937159a9c147c0b1e6 /docs/source/markdown/podman-search.1.md
parent2e6231bcbc05fe204a2b667252fb424b1a25cd00 (diff)
downloadpodman-6236be4ff9ec706926d415a1cb4305ebf49048a7.tar.gz
podman-6236be4ff9ec706926d415a1cb4305ebf49048a7.tar.bz2
podman-6236be4ff9ec706926d415a1cb4305ebf49048a7.zip
[CI:DOCS] Add CI check for SEE ALSO in man pages
Add new CI check to confirm that links and references in SEE ALSO sections are properly formatted and that links are valid (at least in theory: we do no actual URL fetching to test for 404). The check is piggybacked into existing xref-helpmsgs-manpages script. It could conceivably be more elegant to write a separate tool for this purpose, but I don't wish to duplicate the logic for finding and reading markdown files. Script identified various problems, which I fix in this PR: . missing '**' (asterisks) around some references, or '**' in the wrong place. . links pointing to github.com/.../tree/ instead of /blob/ (github redirects those automatically, but I like consistency) . a few copy-paste errors, e.g. subgid linking to subuid. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-search.1.md')
-rw-r--r--docs/source/markdown/podman-search.1.md1
1 files changed, 0 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md
index 0d72a6882..9e166fcc2 100644
--- a/docs/source/markdown/podman-search.1.md
+++ b/docs/source/markdown/podman-search.1.md
@@ -144,7 +144,6 @@ Note: This works only with registries that implement the v2 API. If tried with a
registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion.
## SEE ALSO
-podman(1), containers-registries.conf(5)
**[podman(1)](podman.1.md)**, **[containers-registries(5)](https://github.com/containers/image/blob/main/docs/containers-registries.5.md)**
## HISTORY