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

Remove extra whitespaces in help text of some subcommands #9710

Merged
merged 1 commit into from Aug 3, 2022

Conversation

tkhoa2711
Copy link
Contributor

What I did

A relatively small and simple change to just remove extra leading whitespaces in help text of the run and down subcommands.

What it currently looks like before the change (note the second last line):

> docker compose down --help

Usage:  docker compose down

Stop and remove containers, networks

Options:
      --remove-orphans    Remove containers for services not defined in the Compose file.
      --rmi string        Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")
  -t, --timeout int       Specify a shutdown timeout in seconds (default 10)
  -v, --volumes volumes    Remove named volumes declared in the volumes section of the Compose file and anonymous volumes attached to
                          containers.

Related issue
I didn't create an issue since this is a relatively small.

(not mandatory) A picture of a cute animal, if possible in relation with what you did

@thaJeztah
Copy link
Member

Thank you for contributing! It appears your commit message is missing a DCO sign-off,
causing the DCO check to fail.

We require all commit messages to have a Signed-off-by line with your name
and e-mail (see "Sign your work"
in the CONTRIBUTING.md in this repository), which looks something like:

Signed-off-by: YourFirsName YourLastName <yourname@example.org>

There is no need to open a new pull request, but to fix this (and make CI pass),
you need to amend the commit(s) in this pull request, and "force push" the amended
commit.

Unfortunately, it's not possible to do so through GitHub's web UI, so this needs
to be done through the git commandline.

You can find some instructions in the output of the DCO check (which can be found
in the "checks" tab on this pull request), as well as in the Moby contributing guide.

Steps to do so "roughly" come down to:

  1. Set your name and e-mail in git's configuration:

    git config --global user.name "YourFirstName YourLastName"
    git config --global user.email "yourname@example.org"

    (Make sure to use your real name (not your GitHub username/handle) and e-mail)

  2. Clone your fork locally

  3. Check out the branch associated with this pull request

  4. Sign-off and amend the existing commit(s)

    git commit --amend --no-edit --signoff

    If your pull request contains multiple commits, either squash the commits (if
    needed) or sign-off each individual commit.

  5. Force push your branch to GitHub (using the --force or --force-with-lease flags) to update the pull request.

Sorry for the hassle (I wish GitHub would make this a bit easier to do), and let me know if you need help or more detailed instructions!

@tkhoa2711 tkhoa2711 force-pushed the remove-extra-space-in-help-text branch from bb776d7 to 6e52cfe Compare August 3, 2022 12:30
Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

The change itself looks good to me, let me start CI to verify if the docs also need to be regenerated (not sure if it strips the whitespace when generating the markdown files); you can re-generate the docs with make docs

@tkhoa2711
Copy link
Contributor Author

Looks like I will need to update the markdown docs as well

Signed-off-by: Khoa Le <ltkhoa2711@gmail.com>
@tkhoa2711 tkhoa2711 force-pushed the remove-extra-space-in-help-text branch from 6e52cfe to 7b20fdf Compare August 3, 2022 12:40
@tkhoa2711
Copy link
Contributor Author

@thaJeztah I've updated the docs as well. Another CI trigger approval would be appreciated. Thanks!

@thaJeztah
Copy link
Member

Awesome, thanks! (triggered CI)

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM (not a maintainer, so "non-binding" 😅)

@milas milas merged commit 8d4846f into docker:v2 Aug 3, 2022
@tkhoa2711 tkhoa2711 deleted the remove-extra-space-in-help-text branch August 3, 2022 22:53
laurentsimon pushed a commit to laurentsimon/compose that referenced this pull request Aug 10, 2022
Remove superfluous whitespaces

Signed-off-by: Khoa Le <ltkhoa2711@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants