From 58955a30ffffb8e9dafb8593f4513d6dae53abfd Mon Sep 17 00:00:00 2001 From: SvenDowideit Date: Tue, 15 Jul 2014 10:02:29 +1000 Subject: [PATCH] re-jig the info into all the places Docker-DCO-1.1-Signed-off-by: SvenDowideit (github: SvenDowideit) --- docs/man/docker-pause.1.md | 12 ++++++++++++ docs/man/docker-unpause.1.md | 9 +++++++++ docs/sources/reference/commandline/cli.md | 24 ++++++++++++++++------- 3 files changed, 38 insertions(+), 7 deletions(-) diff --git a/docs/man/docker-pause.1.md b/docs/man/docker-pause.1.md index e6c0c2455d..7b4b091a06 100644 --- a/docs/man/docker-pause.1.md +++ b/docs/man/docker-pause.1.md @@ -8,6 +8,18 @@ docker-pause - Pause all processes within a container **docker pause** CONTAINER +# DESCRIPTION + +The `docker pause` command uses the cgroups freezer to suspend all processes in +a container. Traditionally when suspending a process the `SIGSTOP` signal is +used, which is observable by the process being suspended. With the cgroups freezer +the process is unaware, and unable to capture, that it is being suspended, +and subsequently resumed. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + # OPTIONS There are no available options. diff --git a/docs/man/docker-unpause.1.md b/docs/man/docker-unpause.1.md index 8949548b67..dfce16324e 100644 --- a/docs/man/docker-unpause.1.md +++ b/docs/man/docker-unpause.1.md @@ -8,6 +8,15 @@ docker-unpause - Unpause all processes within a container **docker unpause** CONTAINER +# DESCRIPTION + +The `docker unpause` command uses the cgroups freezer to un-suspend all +processes in a container. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + # OPTIONS There are no available options. diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index d75f2b1443..dac7c1610b 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -764,14 +764,17 @@ log entry. Usage: docker pause CONTAINER - Pause uses the cgroups freezer to suspend all processes in a container. - Traditionally when suspending a process the SIGSTOP signal is used, - which is observable by the process being suspended. With the cgroups freezer - the process is unaware, and unable to capture, that it is being suspended, - and subsequently resumed. + Pause all processes within a container - For for information on the cgroups freezer see: - https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt +The `docker pause` command uses the cgroups freezer to suspend all processes in +a container. Traditionally when suspending a process the `SIGSTOP` signal is +used, which is observable by the process being suspended. With the cgroups freezer +the process is unaware, and unable to capture, that it is being suspended, +and subsequently resumed. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. ## ps @@ -1282,6 +1285,13 @@ them to [*Share Images via Repositories*]( Resumes a paused container. +The `docker unpause` command uses the cgroups freezer to un-suspend all +processes in a container. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + ## version Usage: docker version