diff options
| author | Ed Santiago <santiago@redhat.com> | 2021-01-19 08:58:09 -0700 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2021-01-19 12:59:03 -0700 |
| commit | 37abec240a5f9c0165aa074bb6a58eea1fc665c5 (patch) | |
| tree | ab2a685f3ac148bff3d1e1678cfb93cd825dcd8c /docs/source/markdown/podman-run.1.md | |
| parent | 8c6df5e93e6941a7f50da651678751f7dfec900e (diff) | |
| download | podman-37abec240a5f9c0165aa074bb6a58eea1fc665c5.tar.gz podman-37abec240a5f9c0165aa074bb6a58eea1fc665c5.tar.bz2 podman-37abec240a5f9c0165aa074bb6a58eea1fc665c5.zip | |
[CI:DOCS] fix go-md2man HTMLSpan warnings
I'm tired of seeing these every time I run 'make':
WARNING: go-md2man does not handle node type HTMLSpan
Cause: left-angle-brackets ( < ) in document source
Solution:
1) backquote-escape those that need to be shown, usually
ones referring to an argument or email address; or
2) Actual HTML ( <sup> and <a> ) which are meant to be
shown in generated HTML docs but can't be shown in
man pages, we filter out via a sed expression.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-run.1.md')
| -rw-r--r-- | docs/source/markdown/podman-run.1.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index 74c231184..89f05c308 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -1632,15 +1632,15 @@ NOTE: Use the environment variable `TMPDIR` to change the temporary storage loca **podman-generate-systemd**(1) **podman-rm**(1), **subgid**(5), **subuid**(5), **containers.conf**(5), **systemd.unit**(5), **setsebool**(8), **slirp4netns**(1), **fuse-overlayfs**(1), **proc**(5)**. ## HISTORY -September 2018, updated by Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp> +September 2018, updated by Kunal Kushwaha `<kushwaha_kunal_v7@lab.ntt.co.jp>` -October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman <dwalsh@redhat.com> +October 2017, converted from Docker documentation to Podman by Dan Walsh for Podman `<dwalsh@redhat.com>` -November 2015, updated by Sally O'Malley <somalley@redhat.com> +November 2015, updated by Sally O'Malley `<somalley@redhat.com>` -June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +June 2014, updated by Sven Dowideit `<SvenDowideit@home.org.au>` -April 2014, Originally compiled by William Henry <whenry@redhat.com> based on docker.com source material and internal work. +April 2014, Originally compiled by William Henry `<whenry@redhat.com>` based on docker.com source material and internal work. ## FOOTNOTES <a name="Footnote1">1</a>: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. |