Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[18.09 backport] Fix yamldocs outputing [flags] in usage output #1540

Merged
merged 1 commit into from
Nov 29, 2018

Conversation

thaJeztah
Copy link
Member

backport of #1539 for 18.09

A similar change was made in the CLI itself in #1069, but is not inherited by the code that generates the YAML docs.

Before this patch is applied;

usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...] [flags]

With this patch applied:

usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...]

- How to verify it

run make -f docker.Makefile yamldocs and check the generated YAML files in docs/yaml/gen/

A similar change was made in the CLI itself, but is not
inherited by the code that generates the YAML docs.

Before this patch is applied;

```
usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...] [flags]
```

With this patch applied:

```
usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...]
```

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 44d96e9)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@codecov-io
Copy link

Codecov Report

Merging #1540 into 18.09 will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            18.09    #1540   +/-   ##
=======================================
  Coverage   54.06%   54.06%           
=======================================
  Files         290      290           
  Lines       19403    19403           
=======================================
  Hits        10490    10490           
  Misses       8241     8241           
  Partials      672      672

Copy link
Collaborator

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🐯

Copy link
Contributor

@andrewhsu andrewhsu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@andrewhsu andrewhsu merged commit 61a9096 into docker:18.09 Nov 29, 2018
@thaJeztah thaJeztah deleted the 18.09_backport_fix_flags_in_usage branch November 29, 2018 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants