From 6bc43aa8292a4a245b8c029f64500ff26861087e Mon Sep 17 00:00:00 2001 From: Yong Tang Date: Wed, 23 Nov 2016 23:39:14 -0800 Subject: [PATCH] Update docs of `docker network ls --filter` Currently the help output of `docker network ls --filter` is: ``` Options: -f, --filter value Provide filter values (i.e. 'dangling=true') (default []) ... ``` This caused confusion as only the following filters are supported at the moment: - `driver` - `type` - `name` - `id` - `label` This fix update the help output of `docker network ls --filter` and `network_ls.md`. The `dangling=true` description has been replace to: ``` Options: -f, --filter filter Provide filter values (i.e. 'driver=bridge') ... ``` This fix fixes 28786. Signed-off-by: Yong Tang Upstream-commit: 2510f254eea58788c1a98987db35294beb839bb4 Component: engine --- components/engine/cli/command/network/list.go | 2 +- .../engine/docs/reference/commandline/network_ls.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/components/engine/cli/command/network/list.go b/components/engine/cli/command/network/list.go index 9ba803275b..1a5d285103 100644 --- a/components/engine/cli/command/network/list.go +++ b/components/engine/cli/command/network/list.go @@ -43,7 +43,7 @@ func newListCommand(dockerCli *command.DockerCli) *cobra.Command { flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Only display network IDs") flags.BoolVar(&opts.noTrunc, "no-trunc", false, "Do not truncate the output") flags.StringVar(&opts.format, "format", "", "Pretty-print networks using a Go template") - flags.VarP(&opts.filter, "filter", "f", "Provide filter values (i.e. 'dangling=true')") + flags.VarP(&opts.filter, "filter", "f", "Provide filter values (e.g. 'driver=bridge')") return cmd } diff --git a/components/engine/docs/reference/commandline/network_ls.md b/components/engine/docs/reference/commandline/network_ls.md index ce5fb1d618..42bde111c4 100644 --- a/components/engine/docs/reference/commandline/network_ls.md +++ b/components/engine/docs/reference/commandline/network_ls.md @@ -24,11 +24,11 @@ Aliases: ls, list Options: - -f, --filter value Provide filter values (i.e. 'dangling=true') (default []) - --format string Pretty-print networks using a Go template - --help Print usage - --no-trunc Do not truncate the output - -q, --quiet Only display network IDs + -f, --filter filter Provide filter values (e.g. 'driver=bridge') + --format string Pretty-print networks using a Go template + --help Print usage + --no-trunc Do not truncate the output + -q, --quiet Only display network IDs ``` Lists all the networks the Engine `daemon` knows about. This includes the