فهرست منبع

Fix memory-swap description in older API versions

A value of -1 disables the *limit* so enables unlimited swap

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn 9 سال پیش
والد
کامیت
1c95b858ac

+ 1 - 1
docs/reference/api/docker_remote_api_v1.15.md

@@ -189,7 +189,7 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap**- Total memory usage (memory + swap); set `-1` to disable swap.
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
 -   **CpuShares** - An integer value containing the CPU Shares for container
 -   **CpuShares** - An integer value containing the CPU Shares for container
       (ie. the relative weight vs other containers).
       (ie. the relative weight vs other containers).
     **CpuSet** - String value containing the cgroups Cpuset to use.
     **CpuSet** - String value containing the cgroups Cpuset to use.

+ 1 - 1
docs/reference/api/docker_remote_api_v1.16.md

@@ -189,7 +189,7 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap**- Total memory usage (memory + swap); set `-1` to disable swap.
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
 -   **CpuShares** - An integer value containing the CPU Shares for container
 -   **CpuShares** - An integer value containing the CPU Shares for container
       (ie. the relative weight vs other containers).
       (ie. the relative weight vs other containers).
     **CpuSet** - String value containing the cgroups Cpuset to use.
     **CpuSet** - String value containing the cgroups Cpuset to use.

+ 2 - 2
docs/reference/api/docker_remote_api_v1.17.md

@@ -190,8 +190,8 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap**- Total memory limit (memory + swap); set `-1` to disable swap,
-      always use this with `memory`, and make the value larger than `memory`.
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
+      You must use this with `memory` and make the swap value larger than `memory`.
 -   **CpuShares** - An integer value containing the CPU Shares for container
 -   **CpuShares** - An integer value containing the CPU Shares for container
       (ie. the relative weight vs other containers).
       (ie. the relative weight vs other containers).
     **CpuSet** - String value containing the cgroups Cpuset to use.
     **CpuSet** - String value containing the cgroups Cpuset to use.

+ 3 - 3
docs/reference/api/docker_remote_api_v1.18.md

@@ -207,8 +207,8 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **User** - A string value containing the user to use inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap**- Total memory limit (memory + swap); set `-1` to disable swap,
-      always use this with `memory`, and make the value larger than `memory`.
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
+      You must use this with `memory` and make the swap value larger than `memory`.
 -   **CpuShares** - An integer value containing the CPU Shares for container
 -   **CpuShares** - An integer value containing the CPU Shares for container
       (ie. the relative weight vs other containers).
       (ie. the relative weight vs other containers).
 -   **Cpuset** - The same as CpusetCpus, but deprecated, please don't use.
 -   **Cpuset** - The same as CpusetCpus, but deprecated, please don't use.
@@ -1207,7 +1207,7 @@ Query Parameters:
 -   **rm** - remove intermediate containers after a successful build (default behavior)
 -   **rm** - remove intermediate containers after a successful build (default behavior)
 -   **forcerm** - always remove intermediate containers (includes rm)
 -   **forcerm** - always remove intermediate containers (includes rm)
 -   **memory** - set memory limit for build
 -   **memory** - set memory limit for build
--   **memswap** - Total memory (memory + swap), `-1` to disable swap
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
 -   **cpushares** - CPU shares (relative weight)
 -   **cpushares** - CPU shares (relative weight)
 -   **cpusetcpus** - CPUs in which to allow execution, e.g., `0-3`, `0,1`
 -   **cpusetcpus** - CPUs in which to allow execution, e.g., `0-3`, `0,1`
 
 

+ 2 - 2
docs/reference/api/docker_remote_api_v1.19.md

@@ -214,7 +214,7 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value specifying the user inside the container.
 -   **User** - A string value specifying the user inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap**- Total memory limit (memory + swap); set `-1` to disable swap
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
       You must use this with `memory` and make the swap value larger than `memory`.
       You must use this with `memory` and make the swap value larger than `memory`.
 -   **CpuShares** - An integer value containing the container's CPU Shares
 -   **CpuShares** - An integer value containing the container's CPU Shares
       (ie. the relative weight vs other containers).
       (ie. the relative weight vs other containers).
@@ -1237,7 +1237,7 @@ Query Parameters:
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **memory** - Set memory limit for build.
 -   **memory** - Set memory limit for build.
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
 -   **cpushares** - CPU shares (relative weight).
 -   **cpushares** - CPU shares (relative weight).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpuperiod** - The length of a CPU period in microseconds.
 -   **cpuperiod** - The length of a CPU period in microseconds.

+ 2 - 2
docs/reference/api/docker_remote_api_v1.20.md

@@ -221,7 +221,7 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value specifying the user inside the container.
 -   **User** - A string value specifying the user inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap** - Total memory limit (memory + swap); set `-1` to disable swap
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
       You must use this with `memory` and make the swap value larger than `memory`.
       You must use this with `memory` and make the swap value larger than `memory`.
 -   **CpuShares** - An integer value containing the container's CPU Shares
 -   **CpuShares** - An integer value containing the container's CPU Shares
       (ie. the relative weight vs other containers).
       (ie. the relative weight vs other containers).
@@ -1362,7 +1362,7 @@ Query Parameters:
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **memory** - Set memory limit for build.
 -   **memory** - Set memory limit for build.
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
 -   **cpushares** - CPU shares (relative weight).
 -   **cpushares** - CPU shares (relative weight).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpuperiod** - The length of a CPU period in microseconds.
 -   **cpuperiod** - The length of a CPU period in microseconds.

+ 2 - 2
docs/reference/api/docker_remote_api_v1.21.md

@@ -230,7 +230,7 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value specifying the user inside the container.
 -   **User** - A string value specifying the user inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap** - Total memory limit (memory + swap); set `-1` to disable swap
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
       You must use this with `memory` and make the swap value larger than `memory`.
       You must use this with `memory` and make the swap value larger than `memory`.
 -   **MemoryReservation** - Memory soft limit in bytes.
 -   **MemoryReservation** - Memory soft limit in bytes.
 -   **KernelMemory** - Kernel memory limit in bytes.
 -   **KernelMemory** - Kernel memory limit in bytes.
@@ -1445,7 +1445,7 @@ Query Parameters:
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **memory** - Set memory limit for build.
 -   **memory** - Set memory limit for build.
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
 -   **cpushares** - CPU shares (relative weight).
 -   **cpushares** - CPU shares (relative weight).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpuperiod** - The length of a CPU period in microseconds.
 -   **cpuperiod** - The length of a CPU period in microseconds.

+ 2 - 2
docs/reference/api/docker_remote_api_v1.22.md

@@ -303,7 +303,7 @@ Json Parameters:
       for the container.
       for the container.
 -   **User** - A string value specifying the user inside the container.
 -   **User** - A string value specifying the user inside the container.
 -   **Memory** - Memory limit in bytes.
 -   **Memory** - Memory limit in bytes.
--   **MemorySwap** - Total memory limit (memory + swap); set `-1` to disable swap
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
       You must use this with `memory` and make the swap value larger than `memory`.
       You must use this with `memory` and make the swap value larger than `memory`.
 -   **MemoryReservation** - Memory soft limit in bytes.
 -   **MemoryReservation** - Memory soft limit in bytes.
 -   **KernelMemory** - Kernel memory limit in bytes.
 -   **KernelMemory** - Kernel memory limit in bytes.
@@ -1591,7 +1591,7 @@ Query Parameters:
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
 -   **memory** - Set memory limit for build.
 -   **memory** - Set memory limit for build.
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
 -   **cpushares** - CPU shares (relative weight).
 -   **cpushares** - CPU shares (relative weight).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
 -   **cpuperiod** - The length of a CPU period in microseconds.
 -   **cpuperiod** - The length of a CPU period in microseconds.