Unverified Commit 071d769b authored by Mike McQuaid's avatar Mike McQuaid Committed by GitHub
Browse files

Merge pull request #11770 from kraktus/d

Doc tweaks
parents 4931c6ca e5dfed1b
......@@ -110,8 +110,6 @@ You’re now at a new prompt with the tarball extracted to a temporary sandbox.
Check the package’s `README`. Does the package install with `./configure`, `cmake`, or something else? Delete the commented out `cmake` lines if the package uses `./configure`.
If no compilation is involved and there are no `:build` dependencies, add the line `bottle :unneeded` since bottles are unnecessary in this case. Otherwise, a `bottle` block will be added by Homebrew's CI upon merging the formula's pull-request.
### Check for dependencies
The `README` probably tells you about dependencies and Homebrew or macOS probably already has them. You can check for Homebrew dependencies with `brew search`. Some common dependencies that macOS comes with:
......@@ -255,7 +253,7 @@ For Python formulae, running `brew update-python-resources <formula>` will autom
### Install the formula
brew install --verbose --debug foo
brew install --build-from-source --verbose --debug foo
`--debug` will ask you to open an interactive shell if the build fails so you can try to figure out what went wrong.
......@@ -169,7 +169,6 @@ transparency for contributors in addition to the
- make sure it is one commit per revision bump
- if CI is green and...
- formula `bottle :unneeded`, you can merge it through GitHub UI
- bottles need to be pulled, and...
- the commits are correct, don't need changes, and BrewTestBot can merge it (doesn't have the label `automerge-skip`): approve the PR to trigger an automatic merge (use `brew pr-publish $PR_ID` to trigger manually in case of a new formula)
- the commits are correct and don't need changes, but BrewTestBot can't merge it (has the label `automerge-skip`), use `brew pr-publish $PR_ID`
......@@ -60,7 +60,7 @@ To make a new branch and submit it for review, create a GitHub pull request with
brew tests
brew install --build-from-source <CHANGED_FORMULA>
brew audit --strict <CHANGED_FORMULA>
brew audit --strict --online <CHANGED_FORMULA>
6. [Make a separate commit](Formula-Cookbook.md#commit) for each changed formula with `git add` and `git commit`.
* Please note that our preferred commit message format for simple version updates is "`<FORMULA_NAME> <NEW_VERSION>`", e.g. "`source-highlight 3.1.8`".
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment