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

Remove future tense from man pages

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

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
Daniel J Walsh
2023-05-14 06:46:11 -04:00
parent 3c8d120caa
commit 32c2cea0f9
169 changed files with 619 additions and 629 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/markdown/options/README.md
View File

@ -16,12 +16,12 @@ The files here are included in `podman-*.md.in` files using the `@@option`
mechanism:
```
@@option foo ! will include options/foo.md
@@option foo ! includes options/foo.md
```
The tool that does this is `hack/markdown-preprocess`. It is a python
script because it needs to run on `readthedocs.io`. From a given `.md.in`
file, this script will create a `.md` file that can then be read by
file, this script creates a `.md` file that can then be read by
`go-md2man`, `sphinx`, anything that groks markdown. This runs as
part of `make docs`.
@ -32,11 +32,11 @@ Some options are almost identical except for 'pod' vs 'container'
differences. For those, use `<<text for pods|text for containers>>`.
Order is immaterial: the important thing is the presence of the
string "`pod`" in one half but not the other. The correct string
will be chosen based on the filename: if the file contains `-pod`,
is chosen based on the filename: if the file contains `-pod`,
such as `podman-pod-create`, the string with `pod` (case-insensitive)
in it will be chosen.
in it is chosen.
The string `<<subcommand>>` will be replaced with the podman subcommand
The string `<<subcommand>>` is replaced with the podman subcommand
as determined from the filename, e.g., `create` for `podman-create.1.md.in`.
This allows the shared use of examples in the option file:
```
@ -54,7 +54,7 @@ back-ticks in the front and the end of the line. For instance:
\`\`\`Some man page text\`\`\`
This is currently not allowed and will cause a corruption of the
This is currently not allowed and causes a corruption of the
compiled man page. Instead, put the three back-ticks on separate
lines like: