opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 19:44:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Avoid indirect links through quadlet(5)

Browse Source 
On Linux systems, the quadlet(5) manpage points to the actual content at
podman-systemd.unit(5) but this cannot be counted on elsewhere.  In
particular, this symlink isn't installed by the macOS Brew package, and
https://docs.podman.io/en/latest/markdown/quadlet.5.html is a broken
URL.  Symlinks are also unlikely to function properly within the Windows
distribution, though this is untested speculation.

Now that an HTML link to podman-systemd.unit.5.html can be counted on to
work properly, this change also adds hyperlinks to these references.

Signed-off-by: Warren Young <wyoung@tangentsoft.com>
This commit is contained in:
Warren Young
2025-01-21 16:47:17 -07:00
parent 4700d15c12
commit 51d599bce3
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/locale/ja/LC_MESSAGES/markdown.po
View File

@ -1108,14 +1108,14 @@ msgid ""
"container or Kubernetes workloads must run inside a systemd unit. After a" "container or Kubernetes workloads must run inside a systemd unit. After a"
" successful update of an image, the containers using the image get " " successful update of an image, the containers using the image get "
"updated by restarting the systemd units they run in. Please refer to " "updated by restarting the systemd units they run in. Please refer to "
"`quadlet(5)` on how to run Podman under systemd." "`podman-systemd.unit(5)` on how to run Podman under systemd."
msgstr "" msgstr ""
#: ../../source/markdown/podman-auto-update.1.md:16 #: ../../source/markdown/podman-auto-update.1.md:16
msgid "" msgid ""
"To configure a container for auto updates, it must be created with the " "To configure a container for auto updates, it must be created with the "
"`io.containers.autoupdate` label or the `AutoUpdate` field in " "`io.containers.autoupdate` label or the `AutoUpdate` field in "
"`quadlet(5)` with one of the following two values:" "`podman-systemd.unit(5)` with one of the following two values:"
msgstr "" msgstr ""
#: ../../source/markdown/podman-auto-update.1.md:18 #: ../../source/markdown/podman-auto-update.1.md:18
@ -1148,7 +1148,7 @@ msgstr ""
#: ../../source/markdown/podman-auto-update.1.md:31 #: ../../source/markdown/podman-auto-update.1.md:31
msgid "" msgid ""
"Podman supports auto updates for Kubernetes workloads. The auto-update " "Podman supports auto updates for Kubernetes workloads. The auto-update "
"policy can be configured directly via `quadlet(5)` or inside the " "policy can be configured directly via `podman-systemd.unit(5)` or inside the "
"Kubernetes YAML with the Podman-specific annotations mentioned below:" "Kubernetes YAML with the Podman-specific annotations mentioned below:"
msgstr "" msgstr ""
@ -32151,7 +32151,7 @@ msgstr ""
#: ../../source/markdown/podmansh.1.md:130 #: ../../source/markdown/podmansh.1.md:130
msgid "" msgid ""
"**[podman(1)](podman.1.md)**, **[podman-exec(1)](podman-exec.1.md)**, " "**[podman(1)](podman.1.md)**, **[podman-exec(1)](podman-exec.1.md)**, "
"**quadlet(5)**" "**[podman-systemd.unit(5)](podman-systemd.unit.5.md)**"
msgstr "" msgstr ""
#: ../../source/markdown/podmansh.1.md:133 #: ../../source/markdown/podmansh.1.md:133

6
docs/source/markdown/podman-auto-update.1.md.in
View File

@ -10,9 +10,9 @@ podman\-auto-update - Auto update containers according to their auto-update poli
**podman auto-update** pulls down new container images and restarts containers configured for auto updates. **podman auto-update** pulls down new container images and restarts containers configured for auto updates.
To make use of auto updates, the container or Kubernetes workloads must run inside a systemd unit. To make use of auto updates, the container or Kubernetes workloads must run inside a systemd unit.
After a successful update of an image, the containers using the image get updated by restarting the systemd units they run in. After a successful update of an image, the containers using the image get updated by restarting the systemd units they run in.
Please refer to `quadlet(5)` on how to run Podman under systemd. Please refer to `podman-systemd.unit(5)` on how to run Podman under systemd.
To configure a container for auto updates, it must be created with the `io.containers.autoupdate` label or the `AutoUpdate` field in `quadlet(5)` with one of the following two values: To configure a container for auto updates, it must be created with the `io.containers.autoupdate` label or the `AutoUpdate` field in `podman-systemd.unit(5)` with one of the following two values:
* `registry`: If the label is present and set to `registry`, Podman reaches out to the corresponding registry to check if the image has been updated. * `registry`: If the label is present and set to `registry`, Podman reaches out to the corresponding registry to check if the image has been updated.
The label `image` is an alternative to `registry` maintained for backwards compatibility. The label `image` is an alternative to `registry` maintained for backwards compatibility.
@ -27,7 +27,7 @@ If they differ, the local image is considered to be newer and the systemd unit g
### Auto Updates and Kubernetes YAML ### Auto Updates and Kubernetes YAML
Podman supports auto updates for Kubernetes workloads. The auto-update policy can be configured directly via `quadlet(5)` or inside the Kubernetes YAML with the Podman-specific annotations mentioned below: Podman supports auto updates for Kubernetes workloads. The auto-update policy can be configured directly via `podman-systemd.unit(5)` or inside the Kubernetes YAML with the Podman-specific annotations mentioned below:
* `io.containers.autoupdate`: "registry|local" to apply the auto-update policy to all containers * `io.containers.autoupdate`: "registry|local" to apply the auto-update policy to all containers
* `io.containers.autoupdate/$container`: "registry|local" to apply the auto-update policy to `$container` only * `io.containers.autoupdate/$container`: "registry|local" to apply the auto-update policy to `$container` only

2
docs/source/markdown/podmansh.1.md
View File

@ -127,7 +127,7 @@ _EOF
``` ```
## SEE ALSO ## SEE ALSO
**[containers.conf(5)](containers.conf.5.md)**, **[podman(1)](podman.1.md)**, **[podman-exec(1)](podman-exec.1.md)**, **quadlet(5)** **[containers.conf(5)](containers.conf.5.md)**, **[podman(1)](podman.1.md)**, **[podman-exec(1)](podman-exec.1.md)**, **[podman-systemd.unit(5)](podman-systemd.unit.5.md)**
## HISTORY ## HISTORY
May 2023, Originally compiled by Dan Walsh <dwalsh@redhat.com> May 2023, Originally compiled by Dan Walsh <dwalsh@redhat.com>