aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorbenoitc <[email protected]>2016-04-03 23:46:20 +0200
committerLoïc Hoguin <[email protected]>2017-05-15 19:10:46 +0200
commit9292409f21393ec539cdf40720d26b43914f6018 (patch)
treedcac806b43259fed1067098c162ce77087bd55c6 /doc
parent724521b68c19f107437db9fa2ee8def6ff604e0a (diff)
downloaderlang.mk-9292409f21393ec539cdf40720d26b43914f6018.tar.gz
erlang.mk-9292409f21393ec539cdf40720d26b43914f6018.tar.bz2
erlang.mk-9292409f21393ec539cdf40720d26b43914f6018.zip
Add WITHOUT variable to exclude components on build
This allows to ignore lines from the default build.config if needed. For example to not include packages run make WITHOUT=index
Diffstat (limited to 'doc')
-rw-r--r--doc/src/guide/getting_started.asciidoc11
-rw-r--r--doc/src/guide/updating.asciidoc7
2 files changed, 18 insertions, 0 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index ca1391d..5d7d804 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -78,6 +78,17 @@ to bootstrap. This operation is done only once. Consult the
xref:updating[Updating Erlang.mk] chapter for more
information.
+[NOTE]
+----
+By default the file contains a package index. To filter it, run the command
+above with the `WITHOUT=index` argument.
+
+[source,bash]
+$ make -f erlang.mk bootstrap WITHOUT=index
+
+This command will generate the file without the index.
+----
+
Of course, the generated project can now be compiled:
[source,bash]
diff --git a/doc/src/guide/updating.asciidoc b/doc/src/guide/updating.asciidoc
index 61d913d..3c72749 100644
--- a/doc/src/guide/updating.asciidoc
+++ b/doc/src/guide/updating.asciidoc
@@ -61,3 +61,10 @@ You can also name the file differently or put it in a separate folder
by modifying the value for `ERLANG_MK_BUILD_CONFIG`. You can also
tell Erlang.mk to use a different temporary directory by changing
the `ERLANG_MK_BUILD_DIR` variable.
+
+Alternatively you can filter out a plugin in the build config by using the
+`WITHOUT` variable the first time you generate the file. For example this
+commande will filter the index plugin:
+
+[source,bash]
+$ make -f erlang.mk WITHOUT=index