more docs pedantry: "Exit Status" in "podman-rmi" (and others) all underlines
just noticed that some of the man pages strangely format the "Exit Status" sections, such as this example from "podman-rmi" (v1.7.0): Exit Status 0 if all specified images removed 1 if one of the specified images did not exist, and no other failures 2 if one of the specified images has child images or is being used by a con‐ tainer 125 if the command fails for a reason other than an image did not exist or is in use while you can't tell here, "man podman-rmi" renders that entire section of text underlined. the markdown source is: ## Exit Status **_0_** if all specified images removed **_1_** if one of the specified images did not exist, and no other failures **_2_** if one of the specified images has child images or is being used by a container **_125_** if the command fails for a reason other than an image did not exist or is in use it seems that any man page whose markdown under that section that starts with: **_###_** ... underlines the entirety of each entry. (if it's supposed to do that, then it kind of looks just weird, as with "man podman-rmi"). thoughts? rday p.s. "man podman-rmi" is slightly broken anyway because of: Remove an image and its associated containers. ``` podman rmi --force imageID ```` [TOO MANY BACKQUOTES] Remove multiple images by their shortened IDs. ``` but i'll submit a fix for that. rday
On 1/22/20 1:46 PM, Robert P. J. Day wrote:
just noticed that some of the man pages strangely format the "Exit Status" sections, such as this example from "podman-rmi" (v1.7.0):
Exit Status 0 if all specified images removed 1 if one of the specified images did not exist, and no other failures 2 if one of the specified images has child images or is being used by a con‐ tainer 125 if the command fails for a reason other than an image did not exist or is in use
while you can't tell here, "man podman-rmi" renders that entire section of text underlined. the markdown source is:
## Exit Status **_0_** if all specified images removed **_1_** if one of the specified images did not exist, and no other failures **_2_** if one of the specified images has child images or is being used by a container **_125_** if the command fails for a reason other than an image did not exist or is in use
it seems that any man page whose markdown under that section that starts with:
**_###_** ...
underlines the entirety of each entry. (if it's supposed to do that, then it kind of looks just weird, as with "man podman-rmi").
thoughts?
rday
p.s. "man podman-rmi" is slightly broken anyway because of:
Remove an image and its associated containers. ``` podman rmi --force imageID ```` [TOO MANY BACKQUOTES]
Remove multiple images by their shortened IDs. ```
but i'll submit a fix for that.
rday
_______________________________________________ Podman mailing list -- podman@lists.podman.io To unsubscribe send an email to podman-leave@lists.podman.io
On 1/22/20 1:46 PM, Robert P. J. Day wrote:
just noticed that some of the man pages strangely format the "Exit Status" sections, such as this example from "podman-rmi" (v1.7.0):
Exit Status 0 if all specified images removed 1 if one of the specified images did not exist, and no other failures 2 if one of the specified images has child images or is being used by a con‐ tainer 125 if the command fails for a reason other than an image did not exist or is in use
while you can't tell here, "man podman-rmi" renders that entire section of text underlined. the markdown source is:
## Exit Status **_0_** if all specified images removed **_1_** if one of the specified images did not exist, and no other failures **_2_** if one of the specified images has child images or is being used by a container **_125_** if the command fails for a reason other than an image did not exist or is in use
it seems that any man page whose markdown under that section that starts with:
**_###_** ...
underlines the entirety of each entry. (if it's supposed to do that, then it kind of looks just weird, as with "man podman-rmi").
thoughts?
rday
p.s. "man podman-rmi" is slightly broken anyway because of:
Remove an image and its associated containers. ``` podman rmi --force imageID ```` [TOO MANY BACKQUOTES]
Remove multiple images by their shortened IDs. ```
but i'll submit a fix for that.
rday
_______________________________________________ Podman mailing list -- podman@lists.podman.io To unsubscribe send an email to podman-leave@lists.podman.io
participants (2)
-
Daniel Walsh -
Robert P. J. Day