[CI:DOCS] man pages: replace -c with --cpu-shares

[eriksjolund]

These three man pages have some similar text.

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

Lines 247 to 256 in edbfbfc

	For example, consider a system with more than three cores. If you start one
	container **{C0}** with **--cpu-shares=512** running one process, and another container
	**{C1}** with **--cpu-shares=1024** running two processes, this can result in the following
	division of CPU shares:
	| PID | container | CPU | CPU share |
	| ---- | ----------- | ------- | ------------ |
	| 100 | {C0} | 0 | 100% of CPU0 |
	| 101 | {C1} | 1 | 100% of CPU1 |
	| 102 | {C1} | 2 | 100% of CPU2 |

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

Lines 231 to 239 in edbfbfc

	For example, consider a system with more than three cores. If you start one
	container **{C0}** with **-c=512** running one process, and another container
	**{C1}** with **-c=1024** running two processes, this can result in the following
	division of CPU shares:
	PID container CPU CPU share
	100 {C0} 0 100% of CPU0
	101 {C1} 1 100% of CPU1
	102 {C1} 2 100% of CPU2

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

Lines 91 to 99 in edbfbfc

	For example, consider a system with more than three cores.
	container **{C0}** is started with **-c=512** running one process, and another container
	**{C1}** with **-c=1024** running two processes, this can result in the following
	division of CPU shares:
	PID container CPU CPU share
	100 {C0} 0 100% of CPU0
	101 {C1} 1 100% of CPU1
	102 {C1} 2 100% of CPU2

I assume podman-run.1.md is the correct one (i.e. using --cpu-shares= instead of -c=)

Signed-off-by: Erik Sjölund [email protected]

Does this PR introduce a user-facing change?

None

[rhatdan]

-c and --cpu-shares are the same, although having these use --cpu-shares is easier for humans to understand.
LGTM

[rhatdan]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: eriksjolund, rhatdan

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

[eriksjolund]

It seems the man pages don't mention -c

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

Line 223 in edbfbfc

#### **--cpu-shares**=*shares*

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

Line 64 in edbfbfc

#### **--cpu-shares**=*shares*

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

Line 204 in edbfbfc

#### **--cpu-shares**=*shares*

Should I add that?

[eriksjolund]

-c is not mentioned here either

$ podman create --help| grep cpu-sh
      --cpu-shares uint                          CPU shares (relative weight)
$ podman run --help| grep cpu-sh
      --cpu-shares uint                          CPU shares (relative weight)
$ podman container clone --help| grep cpu-sh
      --cpu-shares uint                       CPU shares (relative weight)
$ 

[rhatdan]

Indeed you are right. Looks like you have found a compatibility issue.

$ podman create --help | grep -- --cpu-shares
      --cpu-shares uint                          CPU shares (relative weight)
$ docker create --help | grep -- --cpu-shares
  -c, --cpu-shares int                 CPU shares (relative weight)

[TomSweeneyRedHat]

@edsantiago sorry, I wasn't clear. I wasn't looking to get them all removed at this point, a fun weekend project for me. What I was wondering if there's a new " you " added in PR for the man pages, just the ones that live in https://github.com/containers/podman/tree/main/docs/source/markdown, then the CI would throw a warning or perhaps fail.

Pronouns in readme's, tutorials, and other docs are fine. We just want to keep the man pages crisp and sans pronouns, or at least " you ".

[edsantiago]

That would require running git diff, which is a big can of worms. I'm sorry.

[TomSweeneyRedHat]

@edsantiago no worries at all, I was hoping it might be quick and easy. Thanks!

[rhatdan]

@eriksjolund You have whitespace issues, and then we can merge.

[eriksjolund]

whitespace now removed

[rhatdan]

/lgtm