github/skopeo
1
0
Fork 0
mirror of https://github.com/containers/skopeo.git synced 2025-07-04 10:26:48 +00:00
Code Issues Projects Releases Wiki Activity

Support **non-replaceable strings** in synopsis

Browse Source 
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
This commit is contained in:
Miloslav Trmač 2021-06-29 23:59:34 +02:00
parent e4d1392085
commit a37251289a
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
hack/man-page-checker
View File

@ -99,6 +99,9 @@ function compare_usage() {
from_man=$(sed -E -e 's/^\[\*options\*\][[:space:]]*//' <<<"$from_man") from_man=$(sed -E -e 's/^\[\*options\*\][[:space:]]*//' <<<"$from_man")
from_help=$(sed -E -e 's/^\[command options\][[:space:]]*//' <<<"$from_help") from_help=$(sed -E -e 's/^\[command options\][[:space:]]*//' <<<"$from_help")
# Constant strings in man page are '**foo**', in --help are 'foo'.
from_man=$(sed -E -e 's/\*\*([^*]+)\*\*/\1/g' <<<"$from_man")
# Args in man page are '*foo*', in --help are 'FOO'. Convert all to # Args in man page are '*foo*', in --help are 'FOO'. Convert all to
# UPCASE simply because it stands out better to the eye. # UPCASE simply because it stands out better to the eye.
from_man=$(sed -E -e 's/_([a-z-]+)_/\U\1/g' <<<"$from_man") from_man=$(sed -E -e 's/_([a-z-]+)_/\U\1/g' <<<"$from_man")
@ -121,7 +124,7 @@ for md in *.1.md;do
# arguments are bracketed by single ones. # arguments are bracketed by single ones.
# E.g. '**skopeo copy** [*options*] _..._' # E.g. '**skopeo copy** [*options*] _..._'
# Get the command name, and confirm that it matches the md file name. # Get the command name, and confirm that it matches the md file name.
cmd=$(echo "$synopsis" | sed -E -e 's/(.*)\*\*.*/\1/' | tr -d \*) cmd=$(echo "$synopsis" | sed -E -e 's/^\*\*([^*]+)\*\*.*/\1/' | tr -d \*)
# Use sed, not tr, so we only replace the first dash: we want # Use sed, not tr, so we only replace the first dash: we want
# skopeo-list-tags -> "skopeo list-tags", not "skopeo list tags" # skopeo-list-tags -> "skopeo list-tags", not "skopeo list tags"
md_nodash=$(basename "$md" .1.md | sed -e 's/-/ /') md_nodash=$(basename "$md" .1.md | sed -e 's/-/ /')