From c3bbd110d631a551f505beba512bcc71c65a4c61 Mon Sep 17 00:00:00 2001 From: kraktus Date: Sun, 25 Jul 2021 20:14:45 +0200 Subject: [PATCH] Docs: better flags for build/test commands When creating a new formula, `--build-from-source` should be added. Adding the `--online` flag make the test more thorough. --- docs/Formula-Cookbook.md | 2 +- docs/How-To-Open-a-Homebrew-Pull-Request.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index 54f444cf40..ee29e1cf19 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -255,7 +255,7 @@ For Python formulae, running `brew update-python-resources ` 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. diff --git a/docs/How-To-Open-a-Homebrew-Pull-Request.md b/docs/How-To-Open-a-Homebrew-Pull-Request.md index 8b2997cff1..54534b9af2 100644 --- a/docs/How-To-Open-a-Homebrew-Pull-Request.md +++ b/docs/How-To-Open-a-Homebrew-Pull-Request.md @@ -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 + brew install --build-from-source --verbose --debug brew test - brew audit --strict + brew audit --strict --online ``` 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 "` `", e.g. "`source-highlight 3.1.8`".