mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: better flags for build/test commands

Browse Source 
When creating a new formula, `--build-from-source` should be added. Adding the `--online` flag make the test more thorough.
This commit is contained in:
kraktus 2021-07-25 20:14:45 +02:00
parent 5ec335188f
commit c3bbd110d6
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Formula-Cookbook.md
View File

@ -255,7 +255,7 @@ For Python formulae, running `brew update-python-resources <formula>` will autom
### Install the formula
```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.

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

@ -58,9 +58,9 @@ To make a new branch and submit it for review, create a GitHub pull request with
5. Test your changes by running the following, and ensure they all pass without issue. For changed formulae, make sure you do the `brew audit` step while your changed formula is installed.
```sh
brew tests
brew install --build-from-source <CHANGED_FORMULA>
brew install --build-from-source --verbose --debug <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`.
* Please note that our preferred commit message format for simple version updates is "`<FORMULA_NAME> <NEW_VERSION>`", e.g. "`source-highlight 3.1.8`".