Browse code

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 authored on 2016/02/02 22:49:14
Showing 8 changed files
... ...
@@ -189,7 +189,7 @@ Json Parameters:
189 189
       for the container.
190 190
 -   **User** - A string value containing the user to use inside the container.
191 191
 -   **Memory** - Memory limit in bytes.
192
--   **MemorySwap**- Total memory usage (memory + swap); set `-1` to disable swap.
192
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
193 193
 -   **CpuShares** - An integer value containing the CPU Shares for container
194 194
       (ie. the relative weight vs other containers).
195 195
     **CpuSet** - String value containing the cgroups Cpuset to use.
... ...
@@ -189,7 +189,7 @@ Json Parameters:
189 189
       for the container.
190 190
 -   **User** - A string value containing the user to use inside the container.
191 191
 -   **Memory** - Memory limit in bytes.
192
--   **MemorySwap**- Total memory usage (memory + swap); set `-1` to disable swap.
192
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
193 193
 -   **CpuShares** - An integer value containing the CPU Shares for container
194 194
       (ie. the relative weight vs other containers).
195 195
     **CpuSet** - String value containing the cgroups Cpuset to use.
... ...
@@ -190,8 +190,8 @@ Json Parameters:
190 190
       for the container.
191 191
 -   **User** - A string value containing the user to use inside the container.
192 192
 -   **Memory** - Memory limit in bytes.
193
--   **MemorySwap**- Total memory limit (memory + swap); set `-1` to disable swap,
194
-      always use this with `memory`, and make the value larger than `memory`.
193
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
194
+      You must use this with `memory` and make the swap value larger than `memory`.
195 195
 -   **CpuShares** - An integer value containing the CPU Shares for container
196 196
       (ie. the relative weight vs other containers).
197 197
     **CpuSet** - String value containing the cgroups Cpuset to use.
... ...
@@ -207,8 +207,8 @@ Json Parameters:
207 207
       for the container.
208 208
 -   **User** - A string value containing the user to use inside the container.
209 209
 -   **Memory** - Memory limit in bytes.
210
--   **MemorySwap**- Total memory limit (memory + swap); set `-1` to disable swap,
211
-      always use this with `memory`, and make the value larger than `memory`.
210
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
211
+      You must use this with `memory` and make the swap value larger than `memory`.
212 212
 -   **CpuShares** - An integer value containing the CPU Shares for container
213 213
       (ie. the relative weight vs other containers).
214 214
 -   **Cpuset** - The same as CpusetCpus, but deprecated, please don't use.
... ...
@@ -1207,7 +1207,7 @@ Query Parameters:
1207 1207
 -   **rm** - remove intermediate containers after a successful build (default behavior)
1208 1208
 -   **forcerm** - always remove intermediate containers (includes rm)
1209 1209
 -   **memory** - set memory limit for build
1210
--   **memswap** - Total memory (memory + swap), `-1` to disable swap
1210
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
1211 1211
 -   **cpushares** - CPU shares (relative weight)
1212 1212
 -   **cpusetcpus** - CPUs in which to allow execution, e.g., `0-3`, `0,1`
1213 1213
 
... ...
@@ -214,7 +214,7 @@ Json Parameters:
214 214
       for the container.
215 215
 -   **User** - A string value specifying the user inside the container.
216 216
 -   **Memory** - Memory limit in bytes.
217
--   **MemorySwap**- Total memory limit (memory + swap); set `-1` to disable swap
217
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
218 218
       You must use this with `memory` and make the swap value larger than `memory`.
219 219
 -   **CpuShares** - An integer value containing the container's CPU Shares
220 220
       (ie. the relative weight vs other containers).
... ...
@@ -1237,7 +1237,7 @@ Query Parameters:
1237 1237
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
1238 1238
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
1239 1239
 -   **memory** - Set memory limit for build.
1240
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
1240
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
1241 1241
 -   **cpushares** - CPU shares (relative weight).
1242 1242
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
1243 1243
 -   **cpuperiod** - The length of a CPU period in microseconds.
... ...
@@ -221,7 +221,7 @@ Json Parameters:
221 221
       for the container.
222 222
 -   **User** - A string value specifying the user inside the container.
223 223
 -   **Memory** - Memory limit in bytes.
224
--   **MemorySwap** - Total memory limit (memory + swap); set `-1` to disable swap
224
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
225 225
       You must use this with `memory` and make the swap value larger than `memory`.
226 226
 -   **CpuShares** - An integer value containing the container's CPU Shares
227 227
       (ie. the relative weight vs other containers).
... ...
@@ -1362,7 +1362,7 @@ Query Parameters:
1362 1362
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
1363 1363
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
1364 1364
 -   **memory** - Set memory limit for build.
1365
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
1365
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
1366 1366
 -   **cpushares** - CPU shares (relative weight).
1367 1367
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
1368 1368
 -   **cpuperiod** - The length of a CPU period in microseconds.
... ...
@@ -230,7 +230,7 @@ Json Parameters:
230 230
       for the container.
231 231
 -   **User** - A string value specifying the user inside the container.
232 232
 -   **Memory** - Memory limit in bytes.
233
--   **MemorySwap** - Total memory limit (memory + swap); set `-1` to disable swap
233
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
234 234
       You must use this with `memory` and make the swap value larger than `memory`.
235 235
 -   **MemoryReservation** - Memory soft limit in bytes.
236 236
 -   **KernelMemory** - Kernel memory limit in bytes.
... ...
@@ -1445,7 +1445,7 @@ Query Parameters:
1445 1445
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
1446 1446
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
1447 1447
 -   **memory** - Set memory limit for build.
1448
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
1448
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
1449 1449
 -   **cpushares** - CPU shares (relative weight).
1450 1450
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
1451 1451
 -   **cpuperiod** - The length of a CPU period in microseconds.
... ...
@@ -303,7 +303,7 @@ Json Parameters:
303 303
       for the container.
304 304
 -   **User** - A string value specifying the user inside the container.
305 305
 -   **Memory** - Memory limit in bytes.
306
--   **MemorySwap** - Total memory limit (memory + swap); set `-1` to disable swap
306
+-   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
307 307
       You must use this with `memory` and make the swap value larger than `memory`.
308 308
 -   **MemoryReservation** - Memory soft limit in bytes.
309 309
 -   **KernelMemory** - Kernel memory limit in bytes.
... ...
@@ -1591,7 +1591,7 @@ Query Parameters:
1591 1591
 -   **rm** - Remove intermediate containers after a successful build (default behavior).
1592 1592
 -   **forcerm** - Always remove intermediate containers (includes `rm`).
1593 1593
 -   **memory** - Set memory limit for build.
1594
--   **memswap** - Total memory (memory + swap), `-1` to disable swap.
1594
+-   **memswap** - Total memory (memory + swap), `-1` to enable unlimited swap.
1595 1595
 -   **cpushares** - CPU shares (relative weight).
1596 1596
 -   **cpusetcpus** - CPUs in which to allow execution (e.g., `0-3`, `0,1`).
1597 1597
 -   **cpuperiod** - The length of a CPU period in microseconds.