diff --git a/commands/bake.go b/commands/bake.go index c93e5cef..011909ce 100644 --- a/commands/bake.go +++ b/commands/bake.go @@ -201,10 +201,10 @@ func bakeCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { flags := cmd.Flags() flags.StringArrayVarP(&options.files, "file", "f", []string{}, "Build definition file") - flags.BoolVar(&options.exportLoad, "load", false, "Shorthand for `--set=*.output=type=docker`") + flags.BoolVar(&options.exportLoad, "load", false, `Shorthand for "--set=*.output=type=docker"`) flags.BoolVar(&options.printOnly, "print", false, "Print the options without building") - flags.BoolVar(&options.exportPush, "push", false, "Shorthand for `--set=*.output=type=registry`") - flags.StringArrayVar(&options.overrides, "set", nil, "Override target value (e.g., `targetpattern.key=value`)") + flags.BoolVar(&options.exportPush, "push", false, `Shorthand for "--set=*.output=type=registry"`) + flags.StringArrayVar(&options.overrides, "set", nil, `Override target value (e.g., "targetpattern.key=value")`) commonBuildFlags(&options.commonOptions, flags) diff --git a/commands/build.go b/commands/build.go index bfefd707..9a33bdeb 100644 --- a/commands/build.go +++ b/commands/build.go @@ -14,6 +14,7 @@ import ( "github.com/docker/buildx/util/platformutil" "github.com/docker/buildx/util/progress" "github.com/docker/buildx/util/tracing" + "github.com/docker/cli-docs-tool/annotation" "github.com/docker/cli/cli" "github.com/docker/cli/cli/command" dockeropts "github.com/docker/cli/opts" @@ -277,51 +278,51 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { flags := cmd.Flags() - flags.StringSliceVar(&options.extraHosts, "add-host", []string{}, "Add a custom host-to-IP mapping (format: `host:ip`)") - flags.SetAnnotation("add-host", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#add-entries-to-container-hosts-file---add-host"}) + flags.StringSliceVar(&options.extraHosts, "add-host", []string{}, `Add a custom host-to-IP mapping (format: "host:ip")`) + flags.SetAnnotation("add-host", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#add-entries-to-container-hosts-file---add-host"}) - flags.StringSliceVar(&options.allow, "allow", []string{}, "Allow extra privileged entitlement (e.g., `network.host`, `security.insecure`)") + flags.StringSliceVar(&options.allow, "allow", []string{}, `Allow extra privileged entitlement (e.g., "network.host", "security.insecure")`) flags.StringArrayVar(&options.buildArgs, "build-arg", []string{}, "Set build-time variables") - flags.SetAnnotation("build-arg", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg"}) + flags.SetAnnotation("build-arg", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg"}) - flags.StringArrayVar(&options.cacheFrom, "cache-from", []string{}, "External cache sources (e.g., `user/app:cache`, `type=local,src=path/to/dir`)") + flags.StringArrayVar(&options.cacheFrom, "cache-from", []string{}, `External cache sources (e.g., "user/app:cache", "type=local,src=path/to/dir")`) - flags.StringArrayVar(&options.cacheTo, "cache-to", []string{}, "Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`)") + flags.StringArrayVar(&options.cacheTo, "cache-to", []string{}, `Cache export destinations (e.g., "user/app:cache", "type=local,dest=path/to/dir")`) flags.StringVar(&options.cgroupParent, "cgroup-parent", "", "Optional parent cgroup for the container") - flags.SetAnnotation("cgroup-parent", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#use-a-custom-parent-cgroup---cgroup-parent"}) + flags.SetAnnotation("cgroup-parent", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#use-a-custom-parent-cgroup---cgroup-parent"}) - flags.StringVarP(&options.dockerfileName, "file", "f", "", "Name of the Dockerfile (default: `PATH/Dockerfile`)") - flags.SetAnnotation("file", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f"}) + flags.StringVarP(&options.dockerfileName, "file", "f", "", `Name of the Dockerfile (default: "PATH/Dockerfile")`) + flags.SetAnnotation("file", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f"}) flags.StringVar(&options.imageIDFile, "iidfile", "", "Write the image ID to the file") flags.StringArrayVar(&options.labels, "label", []string{}, "Set metadata for an image") - flags.BoolVar(&options.exportLoad, "load", false, "Shorthand for `--output=type=docker`") + flags.BoolVar(&options.exportLoad, "load", false, `Shorthand for "--output=type=docker"`) - flags.StringVar(&options.networkMode, "network", "default", "Set the networking mode for the RUN instructions during build") + flags.StringVar(&options.networkMode, "network", "default", `Set the networking mode for the "RUN" instructions during build`) - flags.StringArrayVarP(&options.outputs, "output", "o", []string{}, "Output destination (format: `type=local,dest=path`)") + flags.StringArrayVarP(&options.outputs, "output", "o", []string{}, `Output destination (format: "type=local,dest=path")`) flags.StringArrayVar(&options.platforms, "platform", platformsDefault, "Set target platform for build") - flags.BoolVar(&options.exportPush, "push", false, "Shorthand for `--output=type=registry`") + flags.BoolVar(&options.exportPush, "push", false, `Shorthand for "--output=type=registry"`) flags.BoolVarP(&options.quiet, "quiet", "q", false, "Suppress the build output and print image ID on success") - flags.StringArrayVar(&options.secrets, "secret", []string{}, "Secret file to expose to the build (format: `id=mysecret,src=/local/secret`)") + flags.StringArrayVar(&options.secrets, "secret", []string{}, `Secret file to expose to the build (format: "id=mysecret,src=/local/secret")`) - flags.Var(&options.shmSize, "shm-size", "Size of `/dev/shm`") + flags.Var(&options.shmSize, "shm-size", `Size of "/dev/shm"`) - flags.StringArrayVar(&options.ssh, "ssh", []string{}, "SSH agent socket or keys to expose to the build (format: `default|[=|[,]]`)") + flags.StringArrayVar(&options.ssh, "ssh", []string{}, `SSH agent socket or keys to expose to the build (format: "default|[=|[,]]")`) - flags.StringArrayVarP(&options.tags, "tag", "t", []string{}, "Name and optionally a tag (format: `name:tag`)") - flags.SetAnnotation("tag", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t"}) + flags.StringArrayVarP(&options.tags, "tag", "t", []string{}, `Name and optionally a tag (format: "name:tag")`) + flags.SetAnnotation("tag", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t"}) - flags.StringVar(&options.target, "target", "", "Set the target build stage to build.") - flags.SetAnnotation("target", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target"}) + flags.StringVar(&options.target, "target", "", "Set the target build stage to build") + flags.SetAnnotation("target", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target"}) flags.Var(options.ulimits, "ulimit", "Ulimit options") @@ -349,7 +350,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { flags.StringVarP(&ignore, "memory", "m", "", "Memory limit") flags.MarkHidden("memory") - flags.StringVar(&ignore, "memory-swap", "", "Swap limit equal to memory plus swap: `-1` to enable unlimited swap") + flags.StringVar(&ignore, "memory-swap", "", `Swap limit equal to memory plus swap: "-1" to enable unlimited swap`) flags.MarkHidden("memory-swap") flags.Int64VarP(&ignoreInt, "cpu-shares", "c", 0, "CPU shares (relative weight)") @@ -361,10 +362,10 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { flags.Int64Var(&ignoreInt, "cpu-quota", 0, "Limit the CPU CFS (Completely Fair Scheduler) quota") flags.MarkHidden("cpu-quota") - flags.StringVar(&ignore, "cpuset-cpus", "", "CPUs in which to allow execution (`0-3`, `0,1`)") + flags.StringVar(&ignore, "cpuset-cpus", "", `CPUs in which to allow execution ("0-3", "0,1")`) flags.MarkHidden("cpuset-cpus") - flags.StringVar(&ignore, "cpuset-mems", "", "MEMs in which to allow execution (`0-3`, `0,1`)") + flags.StringVar(&ignore, "cpuset-mems", "", `MEMs in which to allow execution ("0-3", "0,1")`) flags.MarkHidden("cpuset-mems") flags.BoolVar(&ignoreBool, "rm", true, "Remove intermediate containers after a successful build") @@ -379,7 +380,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { func commonBuildFlags(options *commonOptions, flags *pflag.FlagSet) { options.noCache = flags.Bool("no-cache", false, "Do not use cache when building the image") - flags.StringVar(&options.progress, "progress", "auto", "Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output") + flags.StringVar(&options.progress, "progress", "auto", `Set type of progress output ("auto", "plain", "tty"). Use plain to show container output`) options.pull = flags.Bool("pull", false, "Always attempt to pull a newer version of the image") flags.StringVar(&options.metadataFile, "metadata-file", "", "Write build result metadata to the file") } diff --git a/commands/create.go b/commands/create.go index 7dc27f27..1d4169fb 100644 --- a/commands/create.go +++ b/commands/create.go @@ -212,7 +212,7 @@ func createCmd(dockerCli command.Cli) *cobra.Command { if len(drivers.String()) > 0 { drivers.WriteString(", ") } - drivers.WriteString(fmt.Sprintf("`%s`", d.Name())) + drivers.WriteString(fmt.Sprintf(`"%s"`, d.Name())) } cmd := &cobra.Command{ diff --git a/commands/prune.go b/commands/prune.go index 2318b0c1..b4207ae5 100644 --- a/commands/prune.go +++ b/commands/prune.go @@ -139,7 +139,7 @@ func pruneCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { flags := cmd.Flags() flags.BoolVarP(&options.all, "all", "a", false, "Remove all unused images, not just dangling ones") - flags.Var(&options.filter, "filter", "Provide filter values (e.g., `until=24h`)") + flags.Var(&options.filter, "filter", `Provide filter values (e.g., "until=24h")`) flags.Var(&options.keepStorage, "keep-storage", "Amount of disk space to keep for cache") flags.BoolVar(&options.verbose, "verbose", false, "Provide a more verbose output") flags.BoolVarP(&options.force, "force", "f", false, "Do not prompt for confirmation") diff --git a/commands/root.go b/commands/root.go index 10993d9b..593d1b47 100644 --- a/commands/root.go +++ b/commands/root.go @@ -4,6 +4,7 @@ import ( "os" imagetoolscmd "github.com/docker/buildx/commands/imagetools" + "github.com/docker/cli-docs-tool/annotation" "github.com/docker/cli/cli-plugins/plugin" "github.com/docker/cli/cli/command" "github.com/spf13/cobra" @@ -15,6 +16,9 @@ func NewRootCmd(name string, isPlugin bool, dockerCli command.Cli) *cobra.Comman Short: "Docker Buildx", Long: `Extended build capabilities with BuildKit`, Use: name, + Annotations: map[string]string{ + annotation.CodeDelimiter: `"`, + }, } if isPlugin { cmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error { diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md index e426cd5c..49b24d02 100644 --- a/docs/reference/buildx_build.md +++ b/docs/reference/buildx_build.md @@ -27,7 +27,7 @@ Start a build | `--label stringArray` | Set metadata for an image | | [`--load`](#load) | Shorthand for `--output=type=docker` | | `--metadata-file string` | Write build result metadata to the file | -| `--network string` | Set the networking mode for the RUN instructions during build | +| `--network string` | Set the networking mode for the `RUN` instructions during build | | `--no-cache` | Do not use cache when building the image | | [`-o`](#output), [`--output stringArray`](#output) | Output destination (format: `type=local,dest=path`) | | [`--platform stringArray`](#platform) | Set target platform for build | @@ -39,7 +39,7 @@ Start a build | [`--shm-size bytes`](#shm-size) | Size of `/dev/shm` | | `--ssh stringArray` | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | | [`-t`](https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t), [`--tag stringArray`](https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t) | Name and optionally a tag (format: `name:tag`) | -| [`--target string`](https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target) | Set the target build stage to build. | +| [`--target string`](https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target) | Set the target build stage to build | | [`--ulimit ulimit`](#ulimit) | Ulimit options | diff --git a/go.mod b/go.mod index aeaddc83..dd38251f 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,7 @@ require ( github.com/containerd/console v1.0.3 github.com/containerd/containerd v1.5.5 github.com/docker/cli v20.10.8+incompatible - github.com/docker/cli-docs-tool v0.2.1 + github.com/docker/cli-docs-tool v0.3.0 github.com/docker/compose-on-kubernetes v0.4.19-0.20190128150448-356b2919c496 // indirect github.com/docker/distribution v2.7.1+incompatible github.com/docker/docker v20.10.7+incompatible diff --git a/go.sum b/go.sum index f055914f..7ea58f63 100644 --- a/go.sum +++ b/go.sum @@ -412,8 +412,8 @@ github.com/distribution/distribution/v3 v3.0.0-20210316161203-a01c71e2477e/go.mo github.com/dnaeon/go-vcr v1.0.1/go.mod h1:aBB1+wY4s93YsC3HHjMBMrwTj2R9FHDzUr9KyGc8n1E= github.com/docker/cli v20.10.3-0.20210702143511-f782d1355eff+incompatible h1:CaaxCD/l9Dxogu6lxf7AQautlv3sHULrasPadayp0fM= github.com/docker/cli v20.10.3-0.20210702143511-f782d1355eff+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -github.com/docker/cli-docs-tool v0.2.1 h1:ffZhhdws6kE+dCKHLMlYROZz8z01RtWbz+g4xz0eBIU= -github.com/docker/cli-docs-tool v0.2.1/go.mod h1:rgW5KKdNpLMBIuH4WQ/1RNh38nH+/Ay5jgL4P0ZMPpY= +github.com/docker/cli-docs-tool v0.3.0 h1:GFp265P7r0k59EmjD3r066iqN1y4L5qlKsBeODJYGXo= +github.com/docker/cli-docs-tool v0.3.0/go.mod h1:rgW5KKdNpLMBIuH4WQ/1RNh38nH+/Ay5jgL4P0ZMPpY= github.com/docker/compose-on-kubernetes v0.4.19-0.20190128150448-356b2919c496 h1:90ytrX1dbzL7Uf/hHiuWwvywC+gikHv4hkAy4CwRTbs= github.com/docker/compose-on-kubernetes v0.4.19-0.20190128150448-356b2919c496/go.mod h1:iT2pYfi580XlpaV4KmK0T6+4/9+XoKmk/fhoDod1emE= github.com/docker/distribution v0.0.0-20190905152932-14b96e55d84c/go.mod h1:0+TTO4EOBfRPhZXAeF1Vu+W3hHZ8eLp8PgKVZlcvtFY= diff --git a/vendor/github.com/docker/cli-docs-tool/annotation/annotation.go b/vendor/github.com/docker/cli-docs-tool/annotation/annotation.go new file mode 100644 index 00000000..400bd9f7 --- /dev/null +++ b/vendor/github.com/docker/cli-docs-tool/annotation/annotation.go @@ -0,0 +1,23 @@ +// Copyright 2021 cli-docs-tool authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package annotation + +const ( + // ExternalURL specifies an external link annotation + ExternalURL = "docs.external.url" + // CodeDelimiter specifies the char that will be converted as code backtick. + // Can be used on cmd for inheritance or a specific flag. + CodeDelimiter = "docs.code-delimiter" +) diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool.go b/vendor/github.com/docker/cli-docs-tool/clidocstool.go index 9dfb8004..302fc59d 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool.go @@ -22,11 +22,6 @@ import ( "github.com/spf13/cobra" ) -const ( - // AnnotationExternalUrl specifies an external link annotation - AnnotationExternalUrl = "docs.external.url" -) - // Options defines options for cli-docs-tool type Options struct { Root *cobra.Command diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go b/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go index 7b1d6ec0..e08a76d0 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool_md.go @@ -24,6 +24,7 @@ import ( "strings" "text/template" + "github.com/docker/cli-docs-tool/annotation" "github.com/spf13/cobra" "github.com/spf13/pflag" ) @@ -51,6 +52,18 @@ func (c *Client) GenMarkdownTree(cmd *cobra.Command) error { sourcePath := filepath.Join(c.source, mdFile) targetPath := filepath.Join(c.target, mdFile) + // check recursively to handle inherited annotations + for curr := cmd; curr != nil; curr = curr.Parent() { + if _, ok := cmd.Annotations[annotation.CodeDelimiter]; !ok { + if cd, cok := curr.Annotations[annotation.CodeDelimiter]; cok { + if cmd.Annotations == nil { + cmd.Annotations = map[string]string{} + } + cmd.Annotations[annotation.CodeDelimiter] = cd + } + } + } + if !fileExists(sourcePath) { var icBuf bytes.Buffer icTpl, err := template.New("ic").Option("missingkey=error").Parse(`# {{ .Command }} @@ -120,7 +133,7 @@ func mdFilename(cmd *cobra.Command) string { func mdMakeLink(txt, link string, f *pflag.Flag, isAnchor bool) string { link = "#" + link - annotations, ok := f.Annotations[AnnotationExternalUrl] + annotations, ok := f.Annotations[annotation.ExternalURL] if ok && len(annotations) > 0 { link = annotations[0] } else { @@ -186,7 +199,13 @@ func mdCmdOutput(cmd *cobra.Command, old string) (string, error) { } name += "`" name = mdMakeLink(name, f.Name, f, isLink) - fmt.Fprintf(b, "%s | %s |\n", mdEscapePipe(name), mdEscapePipe(f.Usage)) + usage := f.Usage + if cd, ok := f.Annotations[annotation.CodeDelimiter]; ok { + usage = strings.ReplaceAll(usage, cd[0], "`") + } else if cd, ok := cmd.Annotations[annotation.CodeDelimiter]; ok { + usage = strings.ReplaceAll(usage, cd, "`") + } + fmt.Fprintf(b, "%s | %s |\n", mdEscapePipe(name), mdEscapePipe(usage)) }) fmt.Fprintln(b, "") } diff --git a/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go b/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go index 91ccf623..55cd49dd 100644 --- a/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go +++ b/vendor/github.com/docker/cli-docs-tool/clidocstool_yaml.go @@ -24,6 +24,7 @@ import ( "sort" "strings" + "github.com/docker/cli-docs-tool/annotation" "github.com/spf13/cobra" "github.com/spf13/pflag" "gopkg.in/yaml.v2" @@ -37,6 +38,7 @@ type cmdOption struct { Description string `yaml:",omitempty"` DetailsURL string `yaml:"details_url,omitempty"` // DetailsURL contains an anchor-id or link for more information on this flag Deprecated bool + Hidden bool MinAPIVersion string `yaml:"min_api_version,omitempty"` Experimental bool ExperimentalCLI bool @@ -164,7 +166,7 @@ func (c *Client) genYamlCustom(cmd *cobra.Command, w io.Writer) error { cliDoc.Usage = cmd.UseLine() } - // Check recursively so that, e.g., `docker stack ls` returns the same output as `docker stack` + // check recursively to handle inherited annotations for curr := cmd; curr != nil; curr = curr.Parent() { if v, ok := curr.Annotations["version"]; ok && cliDoc.MinAPIVersion == "" { cliDoc.MinAPIVersion = v @@ -184,6 +186,14 @@ func (c *Client) genYamlCustom(cmd *cobra.Command, w io.Writer) error { if o, ok := curr.Annotations["ostype"]; ok && cliDoc.OSType == "" { cliDoc.OSType = o } + if _, ok := cmd.Annotations[annotation.CodeDelimiter]; !ok { + if cd, cok := curr.Annotations[annotation.CodeDelimiter]; cok { + if cmd.Annotations == nil { + cmd.Annotations = map[string]string{} + } + cmd.Annotations[annotation.CodeDelimiter] = cd + } + } } anchors := make(map[string]struct{}) @@ -195,11 +205,11 @@ func (c *Client) genYamlCustom(cmd *cobra.Command, w io.Writer) error { flags := cmd.NonInheritedFlags() if flags.HasFlags() { - cliDoc.Options = genFlagResult(flags, anchors) + cliDoc.Options = genFlagResult(cmd, flags, anchors) } flags = cmd.InheritedFlags() if flags.HasFlags() { - cliDoc.InheritedOptions = genFlagResult(flags, anchors) + cliDoc.InheritedOptions = genFlagResult(cmd, flags, anchors) } if hasSeeAlso(cmd) { @@ -237,7 +247,7 @@ func (c *Client) genYamlCustom(cmd *cobra.Command, w io.Writer) error { return nil } -func genFlagResult(flags *pflag.FlagSet, anchors map[string]struct{}) []cmdOption { +func genFlagResult(cmd *cobra.Command, flags *pflag.FlagSet, anchors map[string]struct{}) []cmdOption { var ( result []cmdOption opt cmdOption @@ -262,11 +272,19 @@ func genFlagResult(flags *pflag.FlagSet, anchors map[string]struct{}) []cmdOptio Option: flag.Name, ValueType: flag.Value.Type(), DefaultValue: forceMultiLine(flag.DefValue, defaultValueMaxWidth), - Description: forceMultiLine(flag.Usage, descriptionMaxWidth), Deprecated: len(flag.Deprecated) > 0, + Hidden: flag.Hidden, + } + + usage := flag.Usage + if cd, ok := flag.Annotations[annotation.CodeDelimiter]; ok { + usage = strings.ReplaceAll(usage, cd[0], "`") + } else if cd, ok := cmd.Annotations[annotation.CodeDelimiter]; ok { + usage = strings.ReplaceAll(usage, cd, "`") } + opt.Description = forceMultiLine(usage, descriptionMaxWidth) - if v, ok := flag.Annotations[AnnotationExternalUrl]; ok && len(v) > 0 { + if v, ok := flag.Annotations[annotation.ExternalURL]; ok && len(v) > 0 { opt.DetailsURL = strings.TrimPrefix(v[0], "https://docs.docker.com") } else if _, ok = anchors[flag.Name]; ok { opt.DetailsURL = "#" + flag.Name diff --git a/vendor/modules.txt b/vendor/modules.txt index 49954d2a..800fa5ad 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -102,9 +102,10 @@ github.com/docker/cli/cli/streams github.com/docker/cli/cli/trust github.com/docker/cli/cli/version github.com/docker/cli/opts -# github.com/docker/cli-docs-tool v0.2.1 +# github.com/docker/cli-docs-tool v0.3.0 ## explicit github.com/docker/cli-docs-tool +github.com/docker/cli-docs-tool/annotation # github.com/docker/compose-on-kubernetes v0.4.19-0.20190128150448-356b2919c496 ## explicit github.com/docker/compose-on-kubernetes/api