aboutsummaryrefslogtreecommitdiffstats
path: root/docs/How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md')
-rw-r--r--docs/How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md17
1 files changed, 8 insertions, 9 deletions
diff --git a/docs/How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md b/docs/How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md
index f71c75164..59d488baa 100644
--- a/docs/How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md
+++ b/docs/How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md
@@ -1,6 +1,6 @@
-# How to build software outside Homebrew with Homebrew `keg-only` dependencies
+# How to build software outside Homebrew with Homebrew `keg_only` dependencies
-## What does `keg-only` mean?
+## What does "keg-only" mean?
The [FAQ](FAQ.md) briefly explains this.
@@ -10,20 +10,19 @@ As an example:
This is because Homebrew keeps it locked inside its individual prefix, rather than symlinking to the publicly-available location, usually `/usr/local`.
-## Advice on potential workarounds.
+## Advice on potential workarounds
A number of people in this situation are either forcefully linking `keg_only` tools with `brew link --force` or moving default system utilities out of the `$PATH` and replacing them with manually-created symlinks to the Homebrew-provided tool.
*Please* do not remove macOS native tools and forcefully replace them with symlinks back to the Homebrew-provided tool. Doing so can and likely will cause significant breakage when attempting to build software.
-`brew link --force` creates a warning in `brew doctor` to let both you and maintainers know that link exists and could be causing issues. If you’ve linked something and there’s no problems at all? Feel free to ignore the `brew doctor` error.
+`brew link --force` creates a warning in `brew doctor` to let both you and maintainers know that a link exists that could be causing issues. If you’ve linked something and there’s no problems at all? Feel free to ignore the `brew doctor` error.
## How do I use those tools outside of Homebrew?
Useful, reliable alternatives exist should you wish to use `keg_only` tools outside of Homebrew.
-### Build flags:
-
+### Build flags
You can set flags to give configure scripts or Makefiles a nudge in the right direction. An example of flag setting:
@@ -37,7 +36,7 @@ An example using `pip`:
CFLAGS=-I$(brew --prefix)/opt/icu4c/include LDFLAGS=-L$(brew --prefix)/opt/icu4c/lib pip install pyicu
```
-### `$PATH` modification:
+### `$PATH` modification
You can temporarily prepend your `$PATH` with the tool’s bin directory, such as:
@@ -49,11 +48,11 @@ This will prepend that folder to your `$PATH`, ensuring any build script that se
Changing your `$PATH` using that command ensures the change only exists for the duration of that shell session. Once you are no longer in that session, the `$PATH` reverts to the prior state.
-### `pkg-config` detection:
+### `pkg-config` detection
If the tool you are attempting to build is [pkg-config](https://en.wikipedia.org/wiki/Pkg-config) aware, you can amend your `PKG_CONFIG_PATH` to find that `keg_only` utility’s `.pc` file, if it has them. Not all formulae ship with those files.
-An example of that is:
+An example of this is:
```shell
export PKG_CONFIG_PATH=$(brew --prefix)/opt/openssl/lib/pkgconfig