aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-01-12 15:57:20 +0100
committerLoïc Hoguin <[email protected]>2015-01-12 15:57:20 +0100
commit1729811327320b0f64e54331d3f469399c6898da (patch)
treea61b729c34f99d4c947dacb0fdec805681b08e6d /README.md
parent72a61573442c5a74818c9cdefb94f568250b534a (diff)
downloaderlang.mk-1729811327320b0f64e54331d3f469399c6898da.tar.gz
erlang.mk-1729811327320b0f64e54331d3f469399c6898da.tar.bz2
erlang.mk-1729811327320b0f64e54331d3f469399c6898da.zip
Add "necessary evil" autopatch feature
The point of this feature is to fix common issues users experience. This feature, when used, attempts to fix projects that are incompatible with erlang.mk. It currently is able to build a new Makefile based on information it finds in a rebar.config file (only deps for now) and also to fix the .app.src file in various ways.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index d9717f6..c182429 100644
--- a/README.md
+++ b/README.md
@@ -138,6 +138,24 @@ dep_ct_helper = git https://github.com/extend/ct_helper.git master
Please note that the test dependencies will only be compiled once
when they are fetched, unlike the normal dependencies.
+Autopatch
+---------
+
+The autopatch features allows you to automatically fix packages
+that are not compatible with erlang.mk. It can also be used to
+convert compatible packages to use erlang.mk itself for building
+when used as dependency.
+
+The patching occurs only once, immediately after the package has
+been fetched.
+
+erlang.mk defines a number of packages to be patched. You can add
+more packages to the list by appending the `AUTOPATCH` variable.
+
+``` Makefile
+AUTOPATCH += gproc
+```
+
Releases
--------