-
-
Notifications
You must be signed in to change notification settings - Fork 9.9k
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
Update documentation of brew install syntax to match its actual behav… #2876
Conversation
I don't think |
A line could be added after
which can be
|
Library/Homebrew/cmd/install.rb
Outdated
@@ -1,4 +1,4 @@ | |||
#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] <formula>: | |||
#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] <formula> [`install-options`]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be [<options> ...]
to indicate that these items are optional (square brackets), are a placeholder rather than a literal command (angle brackets), can be multiply specified (ellipsis), and hint at the use of brew options <formulae>
to list which are available.
A suitable explanatory line might be Installation options specific to <formula> may be appended to the command, and can be listed with `brew options` <formula>.
@VonUniGE Looks good but you need to run |
Thanks for your contribution to Homebrew @VonUniGE and for the help @EricFromCanada! Without people like you submitting PRs we couldn't run this project. You both rock! |
…ior.
As stated in issue #1699, the documentation doesn't reflect the actual behavior of
brew install
. When usingbrew install
, install options given bybrew options
can be added after the formula. For example, I can install ffmpeg with chromaprint support withbrew install ffmpeg --with-chromaprint
. Currently the documentation, doesn't reflect this. This patch update the documentation (man page, markdown, andbrew help install
) to match the actual behavior.