Skip to content

Commit

Permalink
adding -c option for docker run/build in manpages
Browse files Browse the repository at this point in the history
Signed-off-by: Vaclav Struhar <struharv@gmail.com>
(cherry picked from commit be219b3)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
  • Loading branch information
struharv authored and thaJeztah committed Aug 25, 2023
1 parent 6efe73a commit d9770a9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions man/docker-build.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ docker-build - Build an image from a Dockerfile
[**--add-host**[=*[]*]]
[**--build-arg**[=*[]*]]
[**--cache-from**[=*[]*]]
[**--cpu-shares**[=*0*]]
[**-c**|**--cpu-shares**[=*0*]]
[**--cgroup-parent**[=*CGROUP-PARENT*]]
[**--help**]
[**--iidfile**[=*CIDFILE*]]
Expand Down Expand Up @@ -153,7 +153,7 @@ In Linux, default is **bridge**.
Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes.
If you omit the size entirely, the system uses `64m`.

**--cpu-shares** *0*
**-c**, **--cpu-shares** *0*
CPU shares (relative weight).

By default, all containers get the same proportion of CPU cycles.
Expand All @@ -166,7 +166,7 @@ In Linux, default is **bridge**.
You can change this proportion by adjusting the container's CPU share
weighting relative to the weighting of all other running containers.

To modify the proportion from the default of 1024, use the **--cpu-shares**
To modify the proportion from the default of 1024, use the **-c** or **--cpu-shares**
flag to set the weighting to 2 or higher.

Container CPU share Flag
Expand Down
6 changes: 3 additions & 3 deletions man/docker-run.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ docker-run - Create and run a new container from an image
[**--annotation**[=*[]*]]
[**--blkio-weight**[=*[BLKIO-WEIGHT]*]]
[**--blkio-weight-device**[=*[]*]]
[**--cpu-shares**[=*0*]]
[**-c**|**--cpu-shares**[=*0*]]
[**--cap-add**[=*[]*]]
[**--cap-drop**[=*[]*]]
[**--cgroupns**[=*[]*]]
Expand Down Expand Up @@ -137,14 +137,14 @@ option can be set multiple times.
**--blkio-weight-device**=[]
Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`).

**--cpu-shares**=*0*
**-c**, **--cpu-shares**=*0*
CPU shares (relative weight)

By default, all containers get the same proportion of CPU cycles. This proportion
can be modified by changing the container's CPU share weighting relative
to the weighting of all other running containers.

To modify the proportion from the default of 1024, use the **--cpu-shares**
To modify the proportion from the default of 1024, use the **-c** or **--cpu-shares**
flag to set the weighting to 2 or higher.

The proportion will only apply when CPU-intensive processes are running.
Expand Down

0 comments on commit d9770a9

Please sign in to comment.