diff --git a/cmd/podman/images/sign.go b/cmd/podman/images/sign.go index beea6d2b8f..2322e07720 100644 --- a/cmd/podman/images/sign.go +++ b/cmd/podman/images/sign.go @@ -57,7 +57,7 @@ func init() { func sign(cmd *cobra.Command, args []string) error { if signOptions.SignBy == "" { - return errors.New("please provide an identity") + return errors.New("no identity provided") } var sigStoreDir string diff --git a/docs/source/markdown/options/cert-dir.md b/docs/source/markdown/options/cert-dir.md index 65192b306d..5fdb8602a5 100644 --- a/docs/source/markdown/options/cert-dir.md +++ b/docs/source/markdown/options/cert-dir.md @@ -5,5 +5,5 @@ #### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. (Default: /etc/containers/certs.d) -Please refer to **[containers-certs.d(5)](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)** for details. +For details, see **[containers-certs.d(5)](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)**. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) diff --git a/docs/source/markdown/podman-auto-update.1.md.in b/docs/source/markdown/podman-auto-update.1.md.in index c615567ff9..c1f4fcdd53 100644 --- a/docs/source/markdown/podman-auto-update.1.md.in +++ b/docs/source/markdown/podman-auto-update.1.md.in @@ -75,7 +75,7 @@ Valid placeholders for the Go template are listed below: If restarting a systemd unit after updating the image has failed, rollback to using the previous image and restart the unit another time. Default is true. -Please note that detecting if a systemd unit has failed is best done by the container sending the READY message via SDNOTIFY. This way, restarting the unit waits until having received the message or a timeout kicked in. Without that, restarting the systemd unit may succeed even if the container has failed shortly after. +Note that detecting if a systemd unit has failed is best done by the container sending the READY message via SDNOTIFY. This way, restarting the unit waits until having received the message or a timeout kicked in. Without that, restarting the systemd unit may succeed even if the container has failed shortly after. For a container to send the READY message via SDNOTIFY it must be created with the `--sdnotify=container` option (see podman-run(1)). The application running inside the container can then execute `systemd-notify --ready` when ready or use the sdnotify bindings of the specific programming language (e.g., sd_notify(3)). diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md index 410aac6e50..2cbb4c46f7 100644 --- a/docs/source/markdown/podman-container-restore.1.md +++ b/docs/source/markdown/podman-container-restore.1.md @@ -148,7 +148,7 @@ The default is **false**. Replaces the ports that the *container* publishes, as configured during the initial *container* start, with a new set of port forwarding rules. -For more details please see **[podman run --publish](podman-run.1.md#--publish)**. +For more details, see **[podman run --publish](podman-run.1.md#--publish)**. #### **--tcp-established** diff --git a/docs/source/markdown/podman-container-runlabel.1.md.in b/docs/source/markdown/podman-container-runlabel.1.md.in index 317a91ffdb..91fa63bee8 100644 --- a/docs/source/markdown/podman-container-runlabel.1.md.in +++ b/docs/source/markdown/podman-container-runlabel.1.md.in @@ -13,7 +13,7 @@ Historically, container images describe the contents (e.g., layers) and how a co `podman container runlabel` addresses the limitation of container images in a simple yet efficient way. Podman reads the contents of the label and interpret it as a command that is executed on the host. This way an image can describe exactly how it is executed by Podman. For instance, a label with the content `/usr/bin/podman run -d --pid=host --privileged \${IMAGE}` instructs the image to be executed in a detached, privileged container that is using the PID namespace of the host. This lifts the self-description of a container image from "what" to "how". -Please note that the `runlabel` command is intended to be run in trusted environments exclusively. Using the command on untrusted images is not recommended. +Note that the `runlabel` command is intended to be run in trusted environments exclusively. Using the command on untrusted images is not recommended. ## VARIABLES diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 0f50b57d74..b247ce1e5c 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -518,7 +518,7 @@ run in detached mode (backgrounded), so Podman can exit but conmon continues to run. Each container has their own instance of conmon. Conmon waits for the container to exit, gathers and saves the exit code, and then launches a Podman process to complete the container cleanup, by shutting down the network and -storage. For more information on conmon, please reference the conmon(8) man +storage. For more information about conmon, see the conmon(8) man page. ## FILES diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md index 1e2035b2af..aea098c0da 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -68,7 +68,7 @@ Use the name of the container for the start, stop, and description in the unit f This option yields unit files that do not expect containers and pods to exist. Instead, new containers and pods are created based on their configuration files. The unit files are created best effort and may need further editing; please review the generated files carefully before using them in production. -Note that `--new` only works on containers and pods created directly via Podman (i.e., `podman [container] {create,run}` or `podman pod create`). It does not work on containers or pods created via the REST API or via `podman kube play`. For `podman kube play`, please use the `podman-kube@.service` systemd template instead. +Note that `--new` only works on containers and pods created directly via Podman (i.e., `podman [container] {create,run}` or `podman pod create`). It does not work on containers or pods created via the REST API or via `podman kube play`. For `podman kube play`, use the `podman-kube@.service` systemd template instead. #### **--no-header** diff --git a/docs/source/markdown/podman-login.1.md.in b/docs/source/markdown/podman-login.1.md.in index fc5d481207..dd826ba68b 100644 --- a/docs/source/markdown/podman-login.1.md.in +++ b/docs/source/markdown/podman-login.1.md.in @@ -18,7 +18,7 @@ Podman first searches for the username and password in the **${XDG\_RUNTIME\_DIR Podman then uses any existing credentials found in **$HOME/.docker/config.json**. If those credentials are not present, Podman creates **${XDG\_RUNTIME\_DIR}/containers/auth.json** (if the file does not exist) and then stores the username and password from STDIN as a base64 encoded string in it. -For more details about format and configurations of the auth.json file, please refer to containers-auth.json(5) +For more details about format and configurations of the auth.json file, see containers-auth.json(5) **podman [GLOBAL OPTIONS]** diff --git a/docs/source/markdown/podman-logout.1.md.in b/docs/source/markdown/podman-logout.1.md.in index d525a25264..893d3942e8 100644 --- a/docs/source/markdown/podman-logout.1.md.in +++ b/docs/source/markdown/podman-logout.1.md.in @@ -10,7 +10,7 @@ podman\-logout - Log out of a container registry **podman logout** logs out of a specified registry server by deleting the cached credentials stored in the **auth.json** file. If the registry is not specified, the first registry under [registries.search] from registries.conf is used. The path of the authentication file can be overridden by the user by setting the **authfile** flag. -The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. For more details about format and configurations of the auth,json file, please refer to containers-auth.json(5) +The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. For more details about format and configurations of the auth,json file, see containers-auth.json(5) All the cached credentials can be removed by setting the **all** flag. **podman [GLOBAL OPTIONS]** diff --git a/docs/source/markdown/podman-machine-init.1.md.in b/docs/source/markdown/podman-machine-init.1.md.in index 80d0a70258..77232bc85c 100644 --- a/docs/source/markdown/podman-machine-init.1.md.in +++ b/docs/source/markdown/podman-machine-init.1.md.in @@ -26,7 +26,8 @@ and a user account inside the VM are added. By default, the VM distribution is [Fedora CoreOS](https://getfedora.org/en/coreos?stream=testing). Fedora CoreOS upgrades come out every 14 days and are detected and installed automatically. The VM is rebooted during the upgrade. -For more information on updates and advanced configuration, please see the FCOS update docs [here](https://docs.fedoraproject.org/en-US/fedora-coreos/auto-updates/) and [here](https://coreos.github.io/zincati/usage/updates-strategy/). +For more information on updates and advanced configuration, +see the Fedora CoreOS documentation about [auto-updates](https://docs.fedoraproject.org/en-US/fedora-coreos/auto-updates/) and [update strategies](https://coreos.github.io/zincati/usage/updates-strategy/). ## OPTIONS diff --git a/docs/source/markdown/podman-machine-os-apply.1.md b/docs/source/markdown/podman-machine-os-apply.1.md index bfaa76ac55..2610e9f60b 100644 --- a/docs/source/markdown/podman-machine-os-apply.1.md +++ b/docs/source/markdown/podman-machine-os-apply.1.md @@ -15,7 +15,7 @@ VM's that use OS's that use rpm-ostreee have the capability to rebase itself fro By default, Podman machines on Mac and Linux use an rpm-ostree based distribution (Fedora CoreOS). -For more information, please see the [rpm-ostree docs](https://coreos.github.io/rpm-ostree/container/). +For more information, see the [rpm-ostree documentation](https://coreos.github.io/rpm-ostree/container/). The default machine name is `podman-machine-default`. If a machine name is not specified as an argument, then the OS changes will be applied to `podman-machine-default`. diff --git a/docs/source/markdown/podman-pod-top.1.md.in b/docs/source/markdown/podman-pod-top.1.md.in index 653807cb88..537cb9d0fc 100644 --- a/docs/source/markdown/podman-pod-top.1.md.in +++ b/docs/source/markdown/podman-pod-top.1.md.in @@ -21,7 +21,7 @@ of a given process. The descriptors can either be passed as separate arguments o ## FORMAT DESCRIPTORS -Please refer to podman-top(1) for a full list of available descriptors. +For a full list of available descriptors, see podman-top(1) ## EXAMPLES diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index b54a59ef10..95f3632996 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -870,7 +870,7 @@ run in detached mode (backgrounded), so Podman can exit but conmon continues to run. Each container has their own instance of conmon. Conmon waits for the container to exit, gathers and saves the exit code, and then launches a Podman process to complete the container cleanup, by shutting down the network and -storage. For more information on conmon, please reference the conmon(8) man +storage. For more information about conmon, see the conmon(8) man page. ## FILES diff --git a/docs/source/markdown/podman-top.1.md.in b/docs/source/markdown/podman-top.1.md.in index 717bd55588..c080081a5e 100644 --- a/docs/source/markdown/podman-top.1.md.in +++ b/docs/source/markdown/podman-top.1.md.in @@ -15,7 +15,7 @@ of a given process. The descriptors can either be passed as separated arguments argument. Note that options and or flags of ps(1) can also be specified; in this case, Podman falls back to executing ps(1) from the host with the specified arguments and flags in the container namespace. If the container has the `CAP_SYS_PTRACE` capability then we will execute ps(1) in the container so it must be installed there. -Please use the "h*" descriptors to extract host-related information. For instance, `podman top $name hpid huser` +To extract host-related information, use the "h*" descriptors. For instance, `podman top $name hpid huser` to display the PID and user of the processes in the host context. ## OPTIONS diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 8126ea37cc..100b34cf84 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -387,7 +387,7 @@ If the **CONTAINERS_CONF** environment variable is set, then its value is used f The mounts.conf file specifies volume mount directories that are automatically mounted inside containers when executing the `podman run` or `podman start` commands. Administrators can override the defaults file by creating `/etc/containers/mounts.conf`. -When Podman runs in rootless mode, the file `$HOME/.config/containers/mounts.conf` overrides the default if it exists. Please refer to containers-mounts.conf(5) for further details. +When Podman runs in rootless mode, the file `$HOME/.config/containers/mounts.conf` overrides the default if it exists. For details, see containers-mounts.conf(5). **policy.json** (`/etc/containers/policy.json`) @@ -444,7 +444,7 @@ The Overlay file system (OverlayFS) is not supported with kernels prior to 5.12. The Network File System (NFS) and other distributed file systems (for example: Lustre, Spectrum Scale, the General Parallel File System (GPFS)) are not supported when running in rootless mode as these file systems do not understand user namespace. However, rootless Podman can make use of an NFS Homedir by modifying the `$HOME/.config/containers/storage.conf` to have the `graphroot` option point to a directory stored on local (Non NFS) storage. -For more information, please refer to the [Podman Troubleshooting Page](https://github.com/containers/podman/blob/main/troubleshooting.md). +For more information, see the [Podman Troubleshooting Page](https://github.com/containers/podman/blob/main/troubleshooting.md). ## SEE ALSO **[containers-mounts.conf(5)](https://github.com/containers/common/blob/main/docs/containers-mounts.conf.5.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)**, **[containers-storage.conf(5)](https://github.com/containers/storage/blob/main/docs/containers-storage.conf.5.md)**, **[buildah(1)](https://github.com/containers/buildah/blob/main/docs/buildah.1.md)**, **oci-hooks(5)**, **[containers-policy.json(5)](https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md)**, **[crun(1)](https://github.com/containers/crun/blob/main/crun.1.md)**, **[runc(8)](https://github.com/opencontainers/runc/blob/main/man/runc.8.md)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)** diff --git a/docs/tutorials/podman_tutorial.md b/docs/tutorials/podman_tutorial.md index b8b4b104ef..6843a05071 100644 --- a/docs/tutorials/podman_tutorial.md +++ b/docs/tutorials/podman_tutorial.md @@ -13,7 +13,7 @@ root escalation is required. ## Installing Podman -For installing or building Podman, please see the [installation instructions](https://podman.io/getting-started/installation). +For installing or building Podman, see the [installation instructions](https://podman.io/getting-started/installation). ## Familiarizing yourself with Podman diff --git a/docs/tutorials/rootless_tutorial.md b/docs/tutorials/rootless_tutorial.md index da2feac9ad..de7896bcfe 100644 --- a/docs/tutorials/rootless_tutorial.md +++ b/docs/tutorials/rootless_tutorial.md @@ -19,11 +19,11 @@ or for all commands by changing the value for the "Default OCI runtime" in the ` ### Installing Podman -For installing Podman, please see the [installation instructions](https://podman.io/getting-started/installation). +For installing Podman, see the [installation instructions](https://podman.io/getting-started/installation). ### Building Podman -For building Podman, please see the [build instructions](https://podman.io/getting-started/installation#building-from-scratch). +For building Podman, see the [build instructions](https://podman.io/getting-started/installation#building-from-scratch). ### Install `slirp4netns`