docs/podman.1: Link to hook documentation #772
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mheon
reviewed
May 15, 2018
docs/podman.1.md
Outdated
| @@ -121,6 +121,14 @@ has the capability to debug pods/images created by crio. | |||
|
|
|||
| Note this is not a volume mount. The content of the volumes is copied into container storage, not bind mounted directly from the host. | |||
|
|
|||
| **hook JSON** (`/usr/share/containers/oci/hooks.d/*.json`) | |||
|
|
|||
| Each `*.json` file in `/usr/share/containers/oci/hooks.d` configures a hook for Podman containers. For more details on the syntax of the JSON files and the semantics of hook injection, see [the hook documentation](../pkg/hooks/README.md). | |||
There was a problem hiding this comment.
I don't think relative links in a manpage will work, and I don't think we have an actual manpage for the hooks right now
There was a problem hiding this comment.
I don't think relative links in a manpage will work...
Thoughts on the ideas I floated in the final paragraph of the topic post?
There was a problem hiding this comment.
I'd be fine with making the hooks README a manpage and referencing it from this manpage
wking
force-pushed
the
hook-docs
branch
2 times, most recently
from
57a1651 to
0f0954a
Compare
|
I've pushed 57a1651 -> 0f0954a, converting the hooks docs to |
wking
force-pushed
the
hook-docs
branch
2 times, most recently
from
b5ee3c8 to
d2b931a
Compare
|
☔ The latest upstream changes (presumably 1aaf8df) made this pull request unmergeable. Please resolve the merge conflicts. |
|
@wking Needs rebase. |
|
Rebased onto master with d2b931a -> 40a97ac (no conflicts). |
|
LGTM |
wking
force-pushed
the
hook-docs
branch
2 times, most recently
from
a1f3668 to
4e00d12
Compare
|
☔ The latest upstream changes (presumably 796d6c8) made this pull request unmergeable. Please resolve the merge conflicts. |
|
@wking This needs a rebase |
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 <[email protected]>
Collecting the Podman/libpod specifics in one place allows us use the hooks documentation which the previous commit made more generic. The re-ordered SEE ALSO is because [1]: > The list should be ordered by section number and then alphabetically > by name. [1]: http://man7.org/linux/man-pages/man7/man-pages.7.html Signed-off-by: W. Trevor King <[email protected]>
|
LGTM |
|
📌 Commit 9956b8b has been approved by |
rh-atomic-bot
pushed a commit
that referenced
this pull request
May 17, 2018
Collecting the Podman/libpod specifics in one place allows us use the hooks documentation which the previous commit made more generic. The re-ordered SEE ALSO is because [1]: > The list should be ordered by section number and then alphabetically > by name. [1]: http://man7.org/linux/man-pages/man7/man-pages.7.html Signed-off-by: W. Trevor King <[email protected]> Closes: #772 Approved by: mheon
|
☀️ Test successful - status-papr |
wking
added a commit
to wking/libpod
that referenced
this pull request
May 18, 2018
I'd tried to drop it here with ea41561 (hooks/docs: Add oci-hooks.5 and per-package man page building, 2018-05-15, containers#772), but had missed the reference added in 796d6c8 (Add python3 package to podman, 2018-05-17, containers#791) when rebasing around that package. With this commit, I'm killing it again ;). Signed-off-by: W. Trevor King <[email protected]>
rh-atomic-bot
pushed a commit
that referenced
this pull request
May 18, 2018
I'd tried to drop it here with ea41561 (hooks/docs: Add oci-hooks.5 and per-package man page building, 2018-05-15, #772), but had missed the reference added in 796d6c8 (Add python3 package to podman, 2018-05-17, #791) when rebasing around that package. With this commit, I'm killing it again ;). Signed-off-by: W. Trevor King <[email protected]> Closes: #801 Approved by: rhatdan
wking
added a commit
to wking/libpod
that referenced
this pull request
May 19, 2018
I'd accidentally introduced these typos in ea41561 (hooks/docs: Add oci-hooks.5 and per-package man page building, 2018-05-15, containers#772). Signed-off-by: W. Trevor King <[email protected]>
rh-atomic-bot
pushed a commit
that referenced
this pull request
May 21, 2018
I'd accidentally introduced these typos in ea41561 (hooks/docs: Add oci-hooks.5 and per-package man page building, 2018-05-15, #772). Signed-off-by: W. Trevor King <[email protected]> Closes: #810 Approved by: mheon
github-actions
bot
added
the
locked - please file new issue/PR
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Collecting the Podman/libpod specifics in one place allows us to make the hooks README more generic.
I think this is a prereq to adding a Podman/libpod extended stage using the API from #758.
I've currently used a Markdown link here, although links aren't really a man-page thing. The link will work on GitHub, but we may want some pre-processing to replace the link (and our other existing links?) when building for installation. Maybe that means translating the current hooks README into a man page as well.
oci-hooks.5?