opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-10-17 19:24:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Man pages: refactor common options: arch

Browse Source 
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>
This commit is contained in:
Ed Santiago
2022-08-15 12:31:30 -06:00
parent fe54d404ff
commit 22f3dd4c29
7 changed files with 33 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
hack/markdown-preprocess
View File

@ -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()

19
hack/markdown-preprocess.t
View File

@ -37,6 +37,24 @@ class TestPodReplacer(unittest.TestCase):
"""we ignore 'podman'"""
self.assertEqual(mp.replace_type('<<podman container|pod in podman>>', 'container'), 'podman container')
def test_not_at_beginning(self):
"""oops - test for 'pod' other than at beginning of string"""
s = '<<container|container or pod>>'
self.assertEqual(mp.replace_type(s, 'container'), 'container')
self.assertEqual(mp.replace_type(s, 'pod'), 'container or pod')
s = '<<container or pod|container>>'
self.assertEqual(mp.replace_type(s, 'container'), 'container')
self.assertEqual(mp.replace_type(s, 'pod'), 'container or pod')
def test_blank(self):
"""test that either side of '|' can be empty"""
s = 'abc container<<| or pod>> def'
self.assertEqual(mp.replace_type(s, 'container'), 'abc container def')
self.assertEqual(mp.replace_type(s, 'pod'), 'abc container or pod def')
s = 'abc container<< or pod|>> def'
self.assertEqual(mp.replace_type(s, 'container'), 'abc container def')
self.assertEqual(mp.replace_type(s, 'pod'), 'abc container or pod def')
def test_exception_both(self):
"""test that 'pod' on both sides raises exception"""
with self.assertRaisesRegex(Exception, "in both left and right sides"):
@ -52,6 +70,7 @@ class TestPodmanSubcommand(unittest.TestCase):
"""podman subcommand basic test"""
self.assertEqual(mp.podman_subcommand("podman-foo.1.md.in"), "foo")
self.assertEqual(mp.podman_subcommand("podman-foo-bar.1.md.in"), "foo bar")
self.assertEqual(mp.podman_subcommand("podman-pod-rm.1.md.in"), "rm")
if __name__ == '__main__':