diff options
| author | Ed Santiago <santiago@redhat.com> | 2021-11-10 08:44:44 -0700 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2021-11-10 09:03:40 -0700 |
| commit | 6236be4ff9ec706926d415a1cb4305ebf49048a7 (patch) | |
| tree | baff892a3c40e8dce73563937159a9c147c0b1e6 /docs/source/markdown/podman-completion.1.md | |
| parent | 2e6231bcbc05fe204a2b667252fb424b1a25cd00 (diff) | |
| download | podman-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-completion.1.md')
| -rw-r--r-- | docs/source/markdown/podman-completion.1.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-completion.1.md b/docs/source/markdown/podman-completion.1.md index 639332365..7679f74b1 100644 --- a/docs/source/markdown/podman-completion.1.md +++ b/docs/source/markdown/podman-completion.1.md @@ -61,4 +61,4 @@ completion output to a file and source that to the user's powershell profile. More information about profiles is available with **Get-Help about_Profiles**. ## SEE ALSO -**[podman(1)](podman.1.md)**, zsh(1), fish(1), powershell(1) +**[podman(1)](podman.1.md)**, **zsh(1)**, **fish(1)**, **powershell(1)** |