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 /Makefile | |
| 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 'Makefile')
| -rw-r--r-- | Makefile | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -383,7 +383,7 @@ MANPAGES ?= $(MANPAGES_MD:%.md=%) MANPAGES_DEST ?= $(subst markdown,man, $(subst source,build,$(MANPAGES))) $(MANPAGES): %: %.md .install.md2man docdir - @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $(subst source/markdown,build/man,$@) + @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' -e 's;<\(/\)\?\(a[^>]*\|sup\)>;;g' $< | $(GOMD2MAN) -in /dev/stdin -out $(subst source/markdown,build/man,$@) .PHONY: docs docdir: |