Skip to content

Commit

Permalink
Correct memorySwap documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Casper Lans <[email protected]>
  • Loading branch information
cdlans authored and rohanKanojia committed Mar 6, 2021
1 parent e7fefda commit 1244718
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions src/main/asciidoc/inc/external/_property_configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -206,10 +206,10 @@ when a `docker.from` or a `docker.fromExt` is set.
| defines the maintainer's email as used when building an image

| *docker.memory*
| Container memory (in bytes)
| Memory limit in bytes.

| *docker.memorySwap*
| Total memory (swap + memory) `-1` to disable swap
| Total memory limit (memory + swap) in bytes. Set `docker.memorySwap` equal to `docker.memory` to disable swap. Set to `-1` to allow unlimited swap.

| *docker.name*
| Image name
Expand Down
4 changes: 2 additions & 2 deletions src/main/asciidoc/inc/start/_configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ The `<run>` configuration element knows the following sub elements:
| Log configuration for whether and how log messages from the running containers should be printed. This also can configure the https://docs.docker.com/engine/admin/logging/overview[log driver] to use. See <<start-logging,Logging>> for a detailed description.

| *memory*
| Memory limit in bytes
| Memory limit in bytes.

| *memorySwap*
| Total memory usage (memory + swap); use -1 to disable swap.
| Total memory limit (memory + swap) in bytes. Set `memorySwap` equal to `memory` to disable swap. Set to `-1` to allow unlimited swap.

| *namingStrategy*
a| *This option is deprecated, please use a `containerNamePattern` instead* Naming strategy for how the container name is created:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public boolean isDefault() {
@Parameter
private Long memory;

// total memory (swap + ram) in bytes, -1 to disable
// total memory (swap + ram) in bytes; set equal to memory to disable; set to -1 to allow unlimited swap
@Parameter
private Long memorySwap;

Expand Down

0 comments on commit 1244718

Please sign in to comment.