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

Update documentation of brew install syntax to match its actual behav… #2876

Merged
merged 4 commits into from
Jul 13, 2017

Conversation

VonUniGE
Copy link
Contributor

@VonUniGE VonUniGE commented Jul 7, 2017

…ior.

  • [OK] Have you followed the guidelines in our Contributing document?
  • [OK] Have you checked to ensure there aren't other open Pull Requests for the same change?
  • [OK] Have you added an explanation of what your changes do and why you'd like us to include them?

As stated in issue #1699, the documentation doesn't reflect the actual behavior of brew install. When using brew install, install options given by brew options can be added after the formula. For example, I can install ffmpeg with chromaprint support with brew install ffmpeg --with-chromaprint. Currently the documentation, doesn't reflect this. This patch update the documentation (man page, markdown, and brew help install) to match the actual behavior.

@MikeMcQuaid
Copy link
Member

I don't think [install-options] is sufficiently explanatory here. @EricFromCanada, any thoughts?

@VonUniGE
Copy link
Contributor Author

VonUniGE commented Jul 10, 2017

A line could be added after

If --build-bottle is passed, prepare the formula for eventual bottling during installation.

which can be

install-options specific to a package can be listed with brew option formulae.

@@ -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`]:
Copy link
Member

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>.

@MikeMcQuaid
Copy link
Member

@VonUniGE Looks good but you need to run brew man and commit the changes.

@MikeMcQuaid
Copy link
Member

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!

@MikeMcQuaid MikeMcQuaid merged commit 4ca2efb into Homebrew:master Jul 13, 2017
@Homebrew Homebrew locked and limited conversation to collaborators May 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants