aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorjdamanalo <[email protected]>2023-05-08 23:45:43 +0800
committerLoïc Hoguin <[email protected]>2023-05-12 13:25:33 +0200
commit7f7db5d1e6a442aee5dba4aa98dd0594f5f3513d (patch)
tree57c7d3d0397eafa40167497dd1413739f4906a09 /doc/src
parent0f3874feae7ec510c1d2704a37c16d5e47fe9c7d (diff)
downloaderlang.mk-7f7db5d1e6a442aee5dba4aa98dd0594f5f3513d.tar.gz
erlang.mk-7f7db5d1e6a442aee5dba4aa98dd0594f5f3513d.tar.bz2
erlang.mk-7f7db5d1e6a442aee5dba4aa98dd0594f5f3513d.zip
Support optional applications
Loïc: Added more info to guide.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/guide/deps.asciidoc12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/src/guide/deps.asciidoc b/doc/src/guide/deps.asciidoc
index e5dda80..c46dce6 100644
--- a/doc/src/guide/deps.asciidoc
+++ b/doc/src/guide/deps.asciidoc
@@ -132,6 +132,18 @@ target `deps::` before including 'erlang.mk', for example:
[source,make]
deps:: $(CURDIR)/deps/triq
+Sometimes dependencies are allowed to be missing. However, your application
+may depend on an optional application being started. To ensure that an
+optional dependency is started before your application, the variable
+`OPTIONAL_DEPS` may be used:
+
+[source,make]
+OPTIONAL_DEPS = quicer
+
+The top-level project can then decide whether to include this
+application by adding it to its `BUILD_DEPS` and including
+it in the release dependencies.
+
==== Modifying the dependency source or version
By default, Erlang.mk will look into its package index to