diff options
author | W. Trevor King <wking@tremily.us> | 2018-05-15 09:26:38 -0700 |
---|---|---|
committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-05-17 18:22:10 +0000 |
commit | ea4156108d8108e80ed54d2fa17c21f1a5c47310 (patch) | |
tree | 34b94f7b309c870e3d4fda1a22ce73f7ad8a88a1 /contrib/spec/podman.spec.in | |
parent | 3b02a131cd354be3dee7b99c61885d929396f3dc (diff) | |
download | podman-ea4156108d8108e80ed54d2fa17c21f1a5c47310.tar.gz podman-ea4156108d8108e80ed54d2fa17c21f1a5c47310.tar.bz2 podman-ea4156108d8108e80ed54d2fa17c21f1a5c47310.zip |
hooks/docs: Add oci-hooks.5 and per-package man page building
This allows us to reference the hooks docs from podman(1) in a way
that will survive system installation. The downside is that the
GitHub rendered pages become less usable, now that we can no longer
embed links as freely as we could before.
I've followed the "Sections within a manual page" suggestions from
[1].
locale(7) is [2], which is Linux-specific. Even section numbering is
platform-dependent [3], so it's unlikely that these external man
references are particularly portable. Platform packagers can adjust
our local references to match their target system, but that leaves the
GitHub rendering in an awkward place. For now, I think a
Linux-centric GitHub rendering without clickable links may be the best
we can do without moving away from go-md2man.
As far as I can tell, there's not a nice way to get go-md2man to wrap
the links in SEE ALSO without sometimes hyphenating a URL (which makes
it harder for man-page readers to copy/paste those links into their
browser).
I've also fixed some "extention" -> "extension" typos.
[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html
[2]: http://man7.org/linux/man-pages/man7/locale.7.html
[3]: https://en.wikipedia.org/wiki/Man_page#Manual_sections
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #772
Approved by: mheon
Diffstat (limited to 'contrib/spec/podman.spec.in')
-rw-r--r-- | contrib/spec/podman.spec.in | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/contrib/spec/podman.spec.in b/contrib/spec/podman.spec.in index bfe4d99b9..ea2a4092c 100644 --- a/contrib/spec/podman.spec.in +++ b/contrib/spec/podman.spec.in @@ -361,7 +361,6 @@ providing packages with %{import_path} prefix. %prep %autosetup -Sgit -n podman-%{shortcommit} sed -i '/\/bin\/env/d' completions/bash/%{name} -mv pkg/hooks/README.md pkg/hooks/README-hooks.md %build mkdir _build @@ -459,7 +458,7 @@ export GOPATH=%{buildroot}/%{gopath}:$(pwd)/vendor:%{gopath} %files %license LICENSE -%doc README.md CONTRIBUTING.md pkg/hooks/README-hooks.md install.md code-of-conduct.md transfer.md +%doc README.md CONTRIBUTING.md install.md code-of-conduct.md transfer.md %{_bindir}/%{name} %{_mandir}/man1/*.1* %{_mandir}/man5/*.5* @@ -477,14 +476,14 @@ export GOPATH=%{buildroot}/%{gopath}:$(pwd)/vendor:%{gopath} %if 0%{?with_devel} %files -n libpod-devel -f devel.file-list %license LICENSE -%doc README.md CONTRIBUTING.md pkg/hooks/README-hooks.md install.md code-of-conduct.md transfer.md +%doc README.md CONTRIBUTING.md install.md code-of-conduct.md transfer.md %dir %{gopath}/src/%{provider}.%{provider_tld}/%{project} %endif %if 0%{?with_unit_test} && 0%{?with_devel} %files unit-test-devel -f unit-test-devel.file-list %license LICENSE -%doc README.md CONTRIBUTING.md pkg/hooks/README-hooks.md install.md code-of-conduct.md transfer.md +%doc README.md CONTRIBUTING.md install.md code-of-conduct.md transfer.md %endif %changelog |