aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2017-05-15 20:55:06 +0200
committerLoïc Hoguin <[email protected]>2017-05-15 21:37:08 +0200
commit0305622f259c11258cc9d56fa46af28d2206bd43 (patch)
tree84d17c6ac8b8a55455acae1f14a9e9463e823fed /doc
parent9292409f21393ec539cdf40720d26b43914f6018 (diff)
downloaderlang.mk-0305622f259c11258cc9d56fa46af28d2206bd43.tar.gz
erlang.mk-0305622f259c11258cc9d56fa46af28d2206bd43.tar.bz2
erlang.mk-0305622f259c11258cc9d56fa46af28d2206bd43.zip
Add tweaks and tests for the WITHOUT feature
Diffstat (limited to 'doc')
-rw-r--r--doc/src/guide/getting_started.asciidoc11
-rw-r--r--doc/src/guide/updating.asciidoc33
2 files changed, 22 insertions, 22 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index 5d7d804..ca1391d 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -78,17 +78,6 @@ 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 3c72749..8eeb0bf 100644
--- a/doc/src/guide/updating.asciidoc
+++ b/doc/src/guide/updating.asciidoc
@@ -47,10 +47,28 @@ Yep, it's that easy.
=== Customizing the build
-Erlang.mk allows you to customize which plugins are to be included
-in the 'erlang.mk' file. You can do so by maintaining your own
-'build.config' file in your repository. Erlang.mk will automatically
-use it the next time you run `make erlang-mk`.
+Erlang.mk allows you to customize which components are to be included
+in the 'erlang.mk' file. The `WITHOUT` variable allows you to
+remove components from the default Erlang.mk build. The 'build.config'
+file lets you define exactly what goes in (including your own code!),
+and in what order.
+
+The `WITHOUT` file contains the list of components to exclude from
+the build. For example, to exclude the package index and the EDoc
+plugin when bootstrapping your application:
+
+[source,bash]
+$ make -f erlang.mk bootstrap WITHOUT="index plugins/edoc"
+
+The generated Erlang.mk will never include those components when
+you update it, until you change your mind and use the `WITHOUT`
+variable again when you upgrade:
+
+[source,bash]
+$ make erlang-mk WITHOUT=index
+
+The 'build.config' file is automatically used when you bootstrap
+Erlang.mk or when you update it with `make erlang-mk`.
The 'build.config' file contains the list of all files that will
be built into the resulting 'erlang.mk' file. You can start from
@@ -61,10 +79,3 @@ 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