4:25 a.m.
just noticed this breakage in man pages ... when using angle
brackets unprotected by backquotes, such as this in podman-run.1.md:
**--cgroupns**=*mode*
Set the cgroup namespace mode for the container.
**host**: use the host's cgroup namespace inside the container.
**container:<NAME|ID>**: join the namespace of the specified container.
**private**: create a new cgroup namespace.
**ns:<PATH>**: join the namespace at the specified path.
you lose the contents of the angle brackets, so what is rendered (at
least for me on my fedora 31 system) is:
Set the cgroup namespace mode for the container.
host: use the host's cgroup namespace inside the container.
container:: join the namespace of the specified container.
private: create a new cgroup namespace.
ns:: join the namespace at the specified path.
a quick google *suggests* that this can be fixed with a single leading
escape, as in:
**container:\<NAME|ID>**: join the namespace of the specified container.
but i can't test that at the moment as i'm still fighting to set up my
documentation toolchain to build man pages. can someone verify what
the solution is for cases like this? (again, angle brackets within
backquotes render just fine.)
the same problem occurs in that same page (and most likely
elsewhere) when angle brackets are inside single quotes. this snippet:
**--ip**=*ip*
Specify a static IP address for the container, for example
'10.88.64.128'. Can only be used if no additional CNI networks to join
were specified via '--network=<network-name>', and if the container is
not joining another container's network namespace via
'--network=container:<name|id>'. The address must be within the
default CNI network's pool (default 10.88.0.0/16).
when rendered, again loses all content inside angle brackets, as in:
--ip=ip
Specify a static IP address for the container, for example
'10.88.64.128'. Can only be used if no additional CNI networks
to join were specified via '--network=', and if the container
is not joining another container's network namespace via
'--network=container:'. The address must be within the default
CNI network's pool (default 10.88.0.0/16).
and elsewhere:
**--memory**, **-m**=*limit*
Memory limit (format: <number>[<unit>], where unit = b (bytes), k
(kilobytes), m (megabytes), or g (gigabytes))
renders as:
--memory, -m=limit
Memory limit (format: [], where unit = b (bytes), k (kilo‐
bytes), m (megabytes), or g (gigabytes))
so what is the preferred solution?
rday