summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2022-05-07 12:08:45 -0400
committerTavian Barnes <tavianator@tavianator.com>2022-05-07 12:14:06 -0400
commite889335e0a5f5dfb2e15219d841ad8725e4a719b (patch)
tree11d428cbaa540d230fe0741382441dffb8092b03
parent4a29dd9ec419324dac0b7ffaefbaa572fdc3a041 (diff)
downloadbfs-e889335e0a5f5dfb2e15219d841ad8725e4a719b.tar.xz
docs: Move dependency flag info from the README to docs/BUILDING.md
-rw-r--r--README.md12
-rw-r--r--docs/BUILDING.md21
2 files changed, 22 insertions, 11 deletions
diff --git a/README.md b/README.md
index cd90e37..07c5c3b 100644
--- a/README.md
+++ b/README.md
@@ -234,15 +234,6 @@ These are installed by default on many systems, and easy to install on most othe
Refer to your operating system's documentation on building software.
`bfs` also depends on some system libraries for some of its features.
-These dependencies are optional, and can be turned off at build time if necessary by setting the appropriate variable to the empty string (e.g. `make WITH_ONIGURUMA=`).
-
-| Dependency | Platforms | `make` flag |
-|-------------------------------------------------------|------------|------------------|
-| [acl](https://savannah.nongnu.org/projects/acl) | Linux only | `WITH_ACL` |
-| [attr](https://savannah.nongnu.org/projects/attr) | Linux only | `WITH_ATTR` |
-| [libcap](https://sites.google.com/site/fullycapable/) | Linux only | `WITH_LIBCAP` |
-| [Oniguruma](https://github.com/kkos/oniguruma) | All | `WITH_ONIGURUMA` |
-
Here's how to install them on some common platforms:
<pre>
@@ -273,6 +264,9 @@ Here's how to install them on some common platforms:
<strong>Homebrew</strong>
$ brew install oniguruma
</pre>
+
+These dependencies are technically optional, though strongly recommended.
+See the [build documentation](/docs/BUILDING.md#dependencies) for how to disable them.
</details>
<details>
diff --git a/docs/BUILDING.md b/docs/BUILDING.md
index f61c11e..ebab60b 100644
--- a/docs/BUILDING.md
+++ b/docs/BUILDING.md
@@ -56,13 +56,30 @@ Here are some of the common ones; check the [`Makefile`](/Makefile) for more.
| `CC` | The C compiler to use, e.g. `make CC=clang` |
| `CFLAGS`<br>`EXTRA_CFLAGS` | Override/add to the default compiler flags |
| `LDFLAGS`<br>`EXTRA_LDFLAGS` | Override/add to the linker flags |
-| `WITH_ACL`<br>`WITH_ATTR`<br>... | Enable/disable optional dependencies |
+| `WITH_ACL`<br>`WITH_ATTR`<br>... | Enable/disable [optional dependencies] |
| `TEST_FLAGS` | `tests.sh` flags for `make check` |
| `DESTDIR` | The root directory for `make install` |
| `PREFIX` | The installation prefix (default: `/usr`) |
| `MANDIR` | The man page installation directory |
-###
+[optional dependencies]: #dependencies
+
+### Dependencies
+
+`bfs` depends on some system libraries for some of its features.
+These dependencies are optional, and can be turned off at build time if necessary by setting the appropriate variable to the empty string (e.g. `make WITH_ONIGURUMA=`).
+
+| Dependency | Platforms | `make` flag |
+|-------------|------------|------------------|
+| [acl] | Linux only | `WITH_ACL` |
+| [attr] | Linux only | `WITH_ATTR` |
+| [libcap] | Linux only | `WITH_LIBCAP` |
+| [Oniguruma] | All | `WITH_ONIGURUMA` |
+
+[acl]: https://savannah.nongnu.org/projects/acl
+[attr]: https://savannah.nongnu.org/projects/attr
+[libcap]: https://sites.google.com/site/fullycapable/
+[Oniguruma]: https://github.com/kkos/oniguruma
### Dependency tracking