[ci:docs] Remove future tense from man pages #18559

rhatdan · 2023-05-14T10:49:09Z

Remove all will, would, could, should and use present tense.

Does this PR introduce a user-facing change?

Man page cleanup.

vrothberg

LGTM

Luap99 · 2023-05-15T10:29:21Z

@TomSweeneyRedHat PTAL

docs/source/Introduction.rst

docs/source/markdown/options/read-only.md

docs/source/markdown/options/secret.md

docs/source/markdown/options/user-mode-networking.md

TomSweeneyRedHat · 2023-05-15T19:27:58Z

docs/source/markdown/podman-container-checkpoint.1.md

@@ -117,8 +117,7 @@ The default is **false**.

 #### **--latest**, **-l**

-Instead of providing the *container ID* or *name*, use the last created *container*. If other methods than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either of those methods.\
-The default is **false**.\
+Instead of providing the *container ID* or *name*, use the last created *container*. The default is **false**.


Why did you remove the CRI-O bit? It needs to be rewritten, but I think it still holds.

"If tools other than Podman are used to run a container, such as CRI-O or another container engine, the last started container could be from one of those engines.

cri-o does not create containers that --last would refer to. These containers are in the podman database, CRI-O does not use the Podman database.

docs/source/markdown/podman-container-cleanup.1.md

TomSweeneyRedHat · 2023-05-15T19:31:07Z

docs/source/markdown/podman-container-cleanup.1.md

 *IMPORTANT: Conflicts with **--rmi** as the container is not being cleaned up so the image cannot be removed.*

 #### **--latest**, **-l**

-Instead of providing the *container ID* or *name*, use the last created *container*. If other methods than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either of those methods.\
-The default is **false**.\
+Instead of providing the *container ID* or *name*, use the last created *container*. The default is **false**.


ditto CRI-O removal here.

docs/source/markdown/podman-container-restore.1.md

TomSweeneyRedHat · 2023-05-15T19:49:44Z

docs/source/markdown/podman-container-restore.1.md

 The default is **false**.

 #### **--latest**, **-l**

-Instead of providing the *container ID* or *name*, use the last created *container*. If other tools than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either tool.\
-The default is **false**.\
+Instead of providing the *container ID* or *name*, use the last created *container*. The default is **false**.


Ditto CRI-o comment

Ditto reason. :^)

docs/source/markdown/podman-container-restore.1.md

docs/source/markdown/podman-container-runlabel.1.md.in

docs/source/markdown/podman-create.1.md.in

docs/source/markdown/podman-events.1.md

docs/source/markdown/podman-exec.1.md.in

docs/source/markdown/podman-generate-spec.1.md

TomSweeneyRedHat · 2023-05-15T20:06:15Z

docs/source/markdown/podman-generate-systemd.1.md

@@ -17,7 +17,7 @@ Generating unit files for a pod requires the pod to be created with an infra con
 - Note: The generated `podman run` command contains an `--sdnotify` option with the value taken from the container.
 If the container does not have any explicitly set value or the value is set to __ignore__, the value __conmon__ is used.
 The reason for overriding the default value __container__ is that almost no container workloads send notify messages.
-Systemd would wait for a ready message that never comes, if the value __container__ is used for a container
+Systemd waits for a ready message that never comes, if the value __container__ is used for a container


I think "will wait" is better than "waits" in this context, but it is a coinflip.

Suggested change

Systemd waits for a ready message that never comes, if the value __container__ is used for a container

Systemd will wait for a ready message that never comes if the value __container__ is used for a container

docs/source/markdown/podman-generate-systemd.1.md

TomSweeneyRedHat · 2023-05-15T22:34:33Z

docs/source/markdown/podman.1.md

 specify additional options via the `--storage-opt` flag.

 #### **--storage-opt**=*value*

-Specify a storage driver option. Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options override all. Specify --storage-opt="" so no storage options will be used.
+Specify a storage driver option. Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options override all. Specify --storage-opt="" so no storage options is used.


Suggested change

Specify a storage driver option. Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options override all. Specify --storage-opt="" so no storage options is used.

Specify a storage driver option. Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options override all. Specify --storage-opt="" so no storage options are used.

TomSweeneyRedHat · 2023-05-15T22:35:10Z

docs/source/markdown/podman.1.md


 **policy.json** (`/etc/containers/policy.json`)

 Signature verification policy files are used to specify policy, e.g. trusted keys, applicable when deciding whether to accept an image, or individual signatures of that image, as valid.

 **registries.conf** (`/etc/containers/registries.conf`, `$HOME/.config/containers/registries.conf`)

-registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion.
+registries.conf is the configuration file which specifies which container registries is consulted when completing image names which do not include a registry or domain portion.


Suggested change

registries.conf is the configuration file which specifies which container registries is consulted when completing image names which do not include a registry or domain portion.

registries.conf is the configuration file which specifies which container registries are consulted when completing image names that do not include a registry or domain portion.

TomSweeneyRedHat

Away nits, away I SAY!

Done picking. The eyeballs were going, going, gone near the end, I'm sure a few slipped by. Please watch for text that's repeated across multiple man pages.

Luap99 · 2023-05-16T15:50:24Z

@rhatdan Please squash the commits, Apply suggestions from code review isn't helpful to anyone going through the git log.

rhatdan · 2023-05-16T16:01:09Z

@Luap99 I did.

lsm5 · 2023-05-16T18:23:04Z

@rhatdan woah was this manual or is there a tense-checker tool like the spellchecker one?

lsm5 · 2023-05-16T18:24:11Z

LGTM given @TomSweeneyRedHat went through those already 😄

lsm5 · 2023-05-16T18:25:30Z

@rhatdan woah was this manual or is there a tense-checker tool like the spellchecker one?

if there was a tool used, can we please mention it in the commit message? Otherwise, good to go for me.

ashley-cui

/lgtm

sbrivio-rh · 2023-05-16T18:26:04Z

docs/source/markdown/podman-network-create.1.md


-NOTE: The support for the network name pasta is deprecated and will be removed in the next major
+NOTE: The support for the network name "pasta" is deprecated and is removed in the next major


This is an actual future tense because it will actually happen in the future.

good catch!

ashley-cui · 2023-05-16T18:26:49Z

Whoops, may have been a little fast, hopefully the hold will come in time?
/hold

ashley-cui · 2023-05-16T18:30:51Z

/lgtm cancel

sbrivio-rh · 2023-05-16T18:31:20Z

docs/source/markdown/options/cpu-period.md

-duration in microseconds. Once the container's CPU quota is used up, it will
-not be scheduled to run until the current period ends. Defaults to 100000
+duration in microseconds. Once the container's CPU quota is used up, it is not
+scheduled to run until the current period ends. Defaults to 100000


This too, I believe, even if more nuanced, should be a future tense (once ... it will not).

Remove all will, would, could, should and use present tense. Signed-off-by: Daniel J Walsh <[email protected]>

rhatdan · 2023-05-16T19:11:16Z

"if there was a tool used, can we please mention it in the commit message? Otherwise, good to go for me."

Nope brute force on a Saturday morning with little to do.

ashley-cui · 2023-05-16T20:19:14Z

/lgtm

openshift-ci · 2023-05-16T20:20:24Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhatdan, sbrivio-rh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [rhatdan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

rhatdan · 2023-05-16T21:33:43Z

/hold cancel

openshift-ci bot added release-note approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 14, 2023

rhatdan force-pushed the man branch from 8dd5ae1 to 6df7833 Compare May 14, 2023 10:50

vrothberg reviewed May 15, 2023

View reviewed changes

rhatdan force-pushed the man branch from 6df7833 to 0cd57d7 Compare May 15, 2023 09:43