mirror of
https://github.com/containers/podman.git
synced 2025-08-06 19:44:14 +08:00
[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>
This commit is contained in:
@ -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)**
|
||||
|
Reference in New Issue
Block a user