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.

Sign up for GitHub

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

Jump to bottom

Allow external commands display usage instructions with help flag #2391

Closed
wants to merge 2 commits into from
Closed

Allow external commands display usage instructions with help flag #2391

wants to merge 2 commits into from

Conversation

buo
Copy link
Contributor

@buo buo commented Mar 24, 2017 •
edited
Loading

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew tests with your changes locally?

This PR allows external commands display usage instructions with help flag, and fixes #2390.

@buo buo mentioned this pull request Mar 24, 2017
Closed
@MikeMcQuaid
Copy link
Member

See brew services --help and https://github.com/Homebrew/homebrew-services/blob/a5115e47b05e8d2a632ba7775599e698b240e5a2/cmd/brew-services.rb#L1-L31 for an example of how to implement help in external commands.

@buo
Copy link
Contributor Author

buo commented Mar 26, 2017

It's cool! Thanks :)

@buo buo deleted the feature-external-commands-help branch March 26, 2017 02:02
@muescha
Copy link
Contributor

muescha commented Mar 29, 2017

@MikeMcQuaid i miss a documentation about this help feature here http://docs.brew.sh/External-Commands.html

@MikeMcQuaid
Copy link
Member

@muescha Good idea, I'll do that at some stage.

@MikeMcQuaid
Copy link
Member

@muescha Done in fabc5bc

@Homebrew Homebrew locked and limited conversation to collaborators May 3, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feature Request: allow subcommands print help with brew <command> --help
3 participants
@buo @MikeMcQuaid @muescha