aboutsummaryrefslogtreecommitdiff
path: root/hack/markdown-preprocess
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-15 12:31:30 -0600
committerEd Santiago <santiago@redhat.com>2022-08-15 12:31:30 -0600
commit22f3dd4c29de5be5338bdd33a8adbd201e98790d (patch)
treebd4a2a76df412b4703b598fe16212794f510ff79 /hack/markdown-preprocess
parentfe54d404ffbb0b94d48f8a521016a75491652a91 (diff)
downloadpodman-22f3dd4c29de5be5338bdd33a8adbd201e98790d.tar.gz
podman-22f3dd4c29de5be5338bdd33a8adbd201e98790d.tar.bz2
podman-22f3dd4c29de5be5338bdd33a8adbd201e98790d.zip
Man pages: refactor common options: arch
Smaller, more reviewable chunks. This is just one option, --arch. Future PRs may, if the reviewing is easy, include multiple options. This one includes fixes to the preprocessor script, though: * big oops, I was not handling '<<something pod|something>>' where 'pod' appears other than the beginning of the string. * I was also not handling 'container<<| or pod>>', where one side was empty. * Behavior change: <<subcommand>>, on podman-pod-foo, becomes just 'foo' (not 'pod foo'). This will be useful in a future PR where we refactor --pod-id-file. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'hack/markdown-preprocess')
-rwxr-xr-xhack/markdown-preprocess11
1 files changed, 7 insertions, 4 deletions
diff --git a/hack/markdown-preprocess b/hack/markdown-preprocess
index 86667a32d..68e5890d8 100755
--- a/hack/markdown-preprocess
+++ b/hack/markdown-preprocess
@@ -68,6 +68,9 @@ def process(infile):
# Given a file path of the form podman-foo-bar.1.md.in, return "foo bar"
def podman_subcommand(string: str) -> str:
+ # Special case: 'podman-pod-start' becomes just 'start'
+ if string.startswith("podman-pod-"):
+ string = string[len("podman-pod-"):]
if string.startswith("podman-"):
string = string[len("podman-"):]
if string.endswith(".1.md.in"):
@@ -89,8 +92,8 @@ def replace_type(line: str, type: str) -> str:
# conceivably be present in both sides. And we check for 'pod',
# not 'container', because it's possible to have something like
# <<container in pod|container>>.
- if re.match('pod([^m]|$)', lhs, re.IGNORECASE):
- if re.match('pod([^m]|$)', rhs, re.IGNORECASE):
+ if re.match('.*pod([^m]|$)', lhs, re.IGNORECASE):
+ if re.match('.*pod([^m]|$)', rhs, re.IGNORECASE):
raise Exception("'%s' matches 'pod' in both left and right sides" % matchobj[0])
# Only left-hand side has "pod"
if type == 'pod':
@@ -98,14 +101,14 @@ def replace_type(line: str, type: str) -> str:
else:
return rhs
else:
- if not re.match('pod([^m]|$)', rhs, re.IGNORECASE):
+ if not re.match('.*pod([^m]|$)', rhs, re.IGNORECASE):
raise Exception("'%s' does not match 'pod' in either side" % matchobj[0])
if type == 'pod':
return rhs
else:
return lhs
- return re.sub('<<[^\|>]+\|[^\|>]+>>', replwith, line)
+ return re.sub('<<[^\|>]*\|[^\|>]*>>', replwith, line)
if __name__ == "__main__":
main()