From 34504d0a1e912249b8343441d9ea04f8146b2862 Mon Sep 17 00:00:00 2001 From: Sungwon Han Date: Thu, 8 Feb 2018 14:57:41 +0900 Subject: [PATCH] Clarify description of volume prune command volume prune command removes only local volumes not used by at least one container. Signed-off-by: Sungwon Han --- cli/command/volume/prune.go | 4 ++-- cli/command/volume/testdata/volume-prune-no.golden | 2 +- cli/command/volume/testdata/volume-prune-yes.golden | 2 +- docs/reference/commandline/index.md | 2 +- docs/reference/commandline/volume.md | 2 +- docs/reference/commandline/volume_prune.md | 8 ++++---- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/cli/command/volume/prune.go b/cli/command/volume/prune.go index 7db81117b8..b3a70ec776 100644 --- a/cli/command/volume/prune.go +++ b/cli/command/volume/prune.go @@ -22,7 +22,7 @@ func NewPruneCommand(dockerCli command.Cli) *cobra.Command { cmd := &cobra.Command{ Use: "prune [OPTIONS]", - Short: "Remove all unused volumes", + Short: "Remove all unused local volumes", Args: cli.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { spaceReclaimed, output, err := runPrune(dockerCli, options) @@ -45,7 +45,7 @@ func NewPruneCommand(dockerCli command.Cli) *cobra.Command { return cmd } -const warning = `WARNING! This will remove all volumes not used by at least one container. +const warning = `WARNING! This will remove all local volumes not used by at least one container. Are you sure you want to continue?` func runPrune(dockerCli command.Cli, options pruneOptions) (spaceReclaimed uint64, output string, err error) { diff --git a/cli/command/volume/testdata/volume-prune-no.golden b/cli/command/volume/testdata/volume-prune-no.golden index df5a315973..710344c36b 100644 --- a/cli/command/volume/testdata/volume-prune-no.golden +++ b/cli/command/volume/testdata/volume-prune-no.golden @@ -1,2 +1,2 @@ -WARNING! This will remove all volumes not used by at least one container. +WARNING! This will remove all local volumes not used by at least one container. Are you sure you want to continue? [y/N] Total reclaimed space: 0B diff --git a/cli/command/volume/testdata/volume-prune-yes.golden b/cli/command/volume/testdata/volume-prune-yes.golden index 9f6054e92a..54488e2f25 100644 --- a/cli/command/volume/testdata/volume-prune-yes.golden +++ b/cli/command/volume/testdata/volume-prune-yes.golden @@ -1,4 +1,4 @@ -WARNING! This will remove all volumes not used by at least one container. +WARNING! This will remove all local volumes not used by at least one container. Are you sure you want to continue? [y/N] Deleted Volumes: foo bar diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 2e760e2837..ddfdbb9948 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -110,7 +110,7 @@ read the [`dockerd`](dockerd.md) reference page. | [volume create](volume_create.md) | Creates a new volume where containers can consume and store data | | [volume inspect](volume_inspect.md) | Display information about a volume | | [volume ls](volume_ls.md) | Lists all the volumes Docker knows about | -| [volume prune](volume_prune.md) | Remove all unused volumes | +| [volume prune](volume_prune.md) | Remove all unused local volumes | | [volume rm](volume_rm.md) | Remove one or more volumes | ### Swarm node commands diff --git a/docs/reference/commandline/volume.md b/docs/reference/commandline/volume.md index d0e26a4e00..a49fc5e706 100644 --- a/docs/reference/commandline/volume.md +++ b/docs/reference/commandline/volume.md @@ -27,7 +27,7 @@ Commands: create Create a volume inspect Display detailed information on one or more volumes ls List volumes - prune Remove all unused volumes + prune Remove all unused local volumes rm Remove one or more volumes Run 'docker volume COMMAND --help' for more information on a command. diff --git a/docs/reference/commandline/volume_prune.md b/docs/reference/commandline/volume_prune.md index fb08b3d540..8d002381be 100644 --- a/docs/reference/commandline/volume_prune.md +++ b/docs/reference/commandline/volume_prune.md @@ -1,6 +1,6 @@ --- title: "volume prune" -description: "Remove unused volumes" +description: "Remove unused local volumes" keywords: "volume, prune, delete" --- @@ -18,7 +18,7 @@ keywords: "volume, prune, delete" ```markdown Usage: docker volume prune [OPTIONS] -Remove all unused volumes +Remove all unused local volumes Options: --filter filter Provide filter values (e.g. 'label=