admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #11770 from kraktus/d

Browse Source 
Doc tweaks
This commit is contained in:
Mike McQuaid 2021-07-26 13:35:52 +01:00 committed by GitHub
commit 071d769b00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Formula-Cookbook.md
View File

@ -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`. 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 ### 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: 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 ### Install the formula
```sh ```sh
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. `--debug` will ask you to open an interactive shell if the build fails so you can try to figure out what went wrong.

1
docs/Homebrew-homebrew-core-Maintainer-Guide.md
View File

@ -169,7 +169,6 @@ transparency for contributors in addition to the
``` ```
- make sure it is one commit per revision bump - make sure it is one commit per revision bump
- if CI is green and... - if CI is green and...
- formula `bottle :unneeded`, you can merge it through GitHub UI
- bottles need to be pulled, and... - 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, 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` - 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`

2
docs/How-To-Open-a-Homebrew-Pull-Request.md
View File

@ -60,7 +60,7 @@ To make a new branch and submit it for review, create a GitHub pull request with
brew tests brew tests
brew install --build-from-source <CHANGED_FORMULA> brew install --build-from-source <CHANGED_FORMULA>
brew test <CHANGED_FORMULA> brew test <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`. 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`". * Please note that our preferred commit message format for simple version updates is "`<FORMULA_NAME> <NEW_VERSION>`", e.g. "`source-highlight 3.1.8`".