From 2db7fbe722e754523d557476b3832b827ffc0402 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 30 Dec 2015 01:45:48 +0100 Subject: Update user guide --- guide/about.html | 1 + guide/asciidoc.html | 1 + guide/building.html | 1 + guide/ci.html | 1 + guide/code.html | 1 + guide/compat.html | 1 + guide/contributing.html | 1 + guide/coverage.html | 1 + guide/ct.html | 1 + guide/deps.html | 1 + guide/dialyzer.html | 1 + guide/docs.html | 1 + guide/edoc.html | 1 + guide/escript.html | 1 + guide/eunit.html | 1 + guide/getting_started.html | 1 + guide/history.html | 1 + guide/index.html | 3 ++- guide/installation.html | 1 + guide/limitations.html | 1 + guide/overview.html | 1 + guide/plugins.html | 1 + guide/plugins_usage.html | 1 + guide/ports.html | 1 + guide/property_based_testing.html | 1 + guide/relx.html | 1 + guide/shell.html | 1 + guide/tests.html | 1 + guide/updating.html | 1 + guide/why.html | 1 + guide/xref.html | 1 + 31 files changed, 32 insertions(+), 1 deletion(-) diff --git a/guide/about.html b/guide/about.html index 3f5a503..bef883e 100644 --- a/guide/about.html +++ b/guide/about.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/asciidoc.html b/guide/asciidoc.html index e1f6200..1a781d0 100644 --- a/guide/asciidoc.html +++ b/guide/asciidoc.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/building.html b/guide/building.html index ca8d799..b0482c7 100644 --- a/guide/building.html +++ b/guide/building.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/ci.html b/guide/ci.html index 1e95809..ef9811d 100644 --- a/guide/ci.html +++ b/guide/ci.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/code.html b/guide/code.html index d2239ec..add425e 100644 --- a/guide/code.html +++ b/guide/code.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/compat.html b/guide/compat.html index 1f8f3c5..def4498 100644 --- a/guide/compat.html +++ b/guide/compat.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/contributing.html b/guide/contributing.html index b12f2d4..80c5672 100644 --- a/guide/contributing.html +++ b/guide/contributing.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/coverage.html b/guide/coverage.html index 41d0b45..a93a9f0 100644 --- a/guide/coverage.html +++ b/guide/coverage.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/ct.html b/guide/ct.html index 612cade..14c1637 100644 --- a/guide/ct.html +++ b/guide/ct.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/deps.html b/guide/deps.html index 19c9fc0..cbece74 100644 --- a/guide/deps.html +++ b/guide/deps.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/dialyzer.html b/guide/dialyzer.html index ae04077..2d44689 100644 --- a/guide/dialyzer.html +++ b/guide/dialyzer.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/docs.html b/guide/docs.html index b50eebe..065056c 100644 --- a/guide/docs.html +++ b/guide/docs.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/edoc.html b/guide/edoc.html index 73f2c38..26e7744 100644 --- a/guide/edoc.html +++ b/guide/edoc.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/escript.html b/guide/escript.html index 846f2a0..c0a4ef9 100644 --- a/guide/escript.html +++ b/guide/escript.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/eunit.html b/guide/eunit.html index 4b1f1fe..686b23d 100644 --- a/guide/eunit.html +++ b/guide/eunit.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/getting_started.html b/guide/getting_started.html index 14a76b9..b3a9d7f 100644 --- a/guide/getting_started.html +++ b/guide/getting_started.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/history.html b/guide/history.html index 93e2cca..5444ff2 100644 --- a/guide/history.html +++ b/guide/history.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/index.html b/guide/index.html index 93cf980..769cf67 100644 --- a/guide/index.html +++ b/guide/index.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> @@ -31,7 +32,7 @@ div.navfooter{margin-bottom:1em}
-

Erlang.mk User Guide

Loïc Hoguin


Table of Contents

1. Installation
1.1. On Unix
1.2. On Windows
2. Getting started
2.1. Creating a folder for your project
2.2. Downloading Erlang.mk
2.3. Getting started with OTP applications
2.4. Getting started with OTP libraries
2.5. Getting started with OTP releases
2.6. Using spaces instead of tabs
2.7. Using templates
2.8. Getting help
3. Overview
3.1. Building your project
3.2. Exploring the package index
3.3. Generating documentation
3.4. Running tests
3.5. Need more?
4. Updating Erlang.mk
4.1. Initial bootstrap
4.2. Updating
4.3. Customizing the build
5. Limitations
5.1. Erlang must be available
5.2. Spaces in path
5.3. Dependency tracking and modification times
I. Code
6. Building
6.1. How to build
6.2. What to build
6.3. Application resource file
6.4. Automatic application resource file values
6.5. File formats
6.6. Compilation options
6.7. Cold and hot builds
6.8. Dependency tracking
6.9. Generating Erlang source
6.10. Cleaning
7. Packages and dependencies
7.1. Searching packages
7.2. Adding dependencies to your project
7.3. How deps are fetched and built
7.4. Ignoring unwanted dependencies
7.5. Dependencies directory
7.6. Dependencies local to the repository
7.7. Repositories with no application at the root level
7.8. Autopatch
7.9. Skipping deps
8. NIFs and port drivers
8.1. C source code location and Erlang environment
8.2. Using a custom Makefile
8.3. Using Erlang.mk directly
9. Releases
9.1. Setup
9.2. Configuration
9.3. Generating the release
9.4. Running the release
10. Escripts
11. Compatibility with other build tools
11.1. Rebar projects as Erlang.mk dependencies
11.2. Erlang.mk projects as Rebar dependencies
II. Documentation
12. Asciidoc documentation
13. EDoc comments
III. Tests
14. Erlang shell
14.1. Configuration
14.2. Usage
15. EUnit
15.1. Writing tests
15.2. Configuration
15.3. Usage
16. Common Test
16.1. Writing tests
16.2. Configuration
16.3. Usage
17. Property based testing
18. Code coverage
19. Continuous integration
20. Dialyzer
20.1. How it works
20.2. Configuration
20.3. Usage
21. Xref
IV. Third-party plugins
22. External plugins
22.1. Loading all plugins from a dependency
22.2. Loading one plugin from a dependency
22.3. Writing external plugins
V. About Erlang.mk
23. Why Erlang.mk
23.1. Erlang.mk is fast
23.2. Erlang.mk gives you the full power of Unix
23.3. Erlang.mk is a text file
23.4. Erlang.mk can manage Erlang itself
23.5. Erlang.mk can do more than Erlang
23.6. Erlang.mk integrates nicely in Make and Automake projects
24. Short history
24.1. Before Erlang.mk
24.2. Lifetime of the project
25. Contributing
25.1. Priorities
25.2. Bugs
25.3. Code
25.4. Packages
25.5. Documentation
25.6. Feature requests
+

Erlang.mk User Guide

Loïc Hoguin


Table of Contents

1. Installation
1.1. On Unix
1.2. On Windows
2. Getting started
2.1. Creating a folder for your project
2.2. Downloading Erlang.mk
2.3. Getting started with OTP applications
2.4. Getting started with OTP libraries
2.5. Getting started with OTP releases
2.6. Using spaces instead of tabs
2.7. Using templates
2.8. Getting help
3. Overview
3.1. Building your project
3.2. Exploring the package index
3.3. Generating documentation
3.4. Running tests
3.5. Need more?
4. Updating Erlang.mk
4.1. Initial bootstrap
4.2. Updating
4.3. Customizing the build
5. Limitations
5.1. Erlang must be available
5.2. Spaces in path
5.3. Dependency tracking and modification times
I. Code
6. Building
6.1. How to build
6.2. What to build
6.3. Application resource file
6.4. Automatic application resource file values
6.5. File formats
6.6. Compilation options
6.7. Cold and hot builds
6.8. Dependency tracking
6.9. Generating Erlang source
6.10. Cleaning
7. Packages and dependencies
7.1. Searching packages
7.2. Adding dependencies to your project
7.3. How deps are fetched and built
7.4. Ignoring unwanted dependencies
7.5. Dependencies directory
7.6. Dependencies local to the repository
7.7. Repositories with no application at the root level
7.8. Autopatch
7.9. Skipping deps
8. NIFs and port drivers
8.1. C source code location and Erlang environment
8.2. Using a custom Makefile
8.3. Using Erlang.mk directly
9. Releases
9.1. Setup
9.2. Configuration
9.3. Generating the release
9.4. Running the release
10. Escripts
11. Compatibility with other build tools
11.1. Rebar projects as Erlang.mk dependencies
11.2. Erlang.mk projects as Rebar dependencies
II. Documentation
12. Asciidoc documentation
13. EDoc comments
III. Tests
14. Erlang shell
14.1. Configuration
14.2. Usage
15. EUnit
15.1. Writing tests
15.2. Configuration
15.3. Usage
16. Common Test
16.1. Writing tests
16.2. Configuration
16.3. Usage
17. Property based testing
18. Code coverage
19. Continuous integration
20. Dialyzer
20.1. How it works
20.2. Configuration
20.3. Usage
21. Xref
IV. Third-party plugins
22. External plugins
22.1. Loading all plugins from a dependency
22.2. Loading one plugin from a dependency
22.3. Writing external plugins
V. About Erlang.mk
23. Why Erlang.mk
23.1. Erlang.mk is fast
23.2. Erlang.mk gives you the full power of Unix
23.3. Erlang.mk is a text file
23.4. Erlang.mk can manage Erlang itself
23.5. Erlang.mk can do more than Erlang
23.6. Erlang.mk integrates nicely in Make and Automake projects
24. Short history
24.1. Before Erlang.mk
24.2. Lifetime of the project
25. Contributing
25.1. Priorities
25.2. Bugs
25.3. Code
25.4. Packages
25.5. Documentation
25.6. Feature requests
diff --git a/guide/installation.html b/guide/installation.html index ec47c94..7caffd1 100644 --- a/guide/installation.html +++ b/guide/installation.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/limitations.html b/guide/limitations.html index 140d7d7..b22d036 100644 --- a/guide/limitations.html +++ b/guide/limitations.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/overview.html b/guide/overview.html index fa66f9e..cf35ede 100644 --- a/guide/overview.html +++ b/guide/overview.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/plugins.html b/guide/plugins.html index dda7050..fddd8c0 100644 --- a/guide/plugins.html +++ b/guide/plugins.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/plugins_usage.html b/guide/plugins_usage.html index 0a7abbf..a6142b4 100644 --- a/guide/plugins_usage.html +++ b/guide/plugins_usage.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/ports.html b/guide/ports.html index 9cda5a7..c67c981 100644 --- a/guide/ports.html +++ b/guide/ports.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/property_based_testing.html b/guide/property_based_testing.html index 484be6b..41349bb 100644 --- a/guide/property_based_testing.html +++ b/guide/property_based_testing.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/relx.html b/guide/relx.html index 6aae60d..9ee1df6 100644 --- a/guide/relx.html +++ b/guide/relx.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/shell.html b/guide/shell.html index 4504414..0040f48 100644 --- a/guide/shell.html +++ b/guide/shell.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/tests.html b/guide/tests.html index 9f817b1..295e9b7 100644 --- a/guide/tests.html +++ b/guide/tests.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/updating.html b/guide/updating.html index 8e3f41b..af3e489 100644 --- a/guide/updating.html +++ b/guide/updating.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/why.html b/guide/why.html index 6a842e0..ad3dc79 100644 --- a/guide/why.html +++ b/guide/why.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> diff --git a/guide/xref.html b/guide/xref.html index a1de727..3a66aea 100644 --- a/guide/xref.html +++ b/guide/xref.html @@ -13,6 +13,7 @@ main{margin-top:2em;text-align:justify} main h2, main h3{margin-top:2em} a{color:#d9230f;text-decoration:none} a:hover{text-decoration:underline} +a.xref{display:none} h1, h2, h3{font-weight:normal} div.navfooter{margin-bottom:1em} --> -- cgit v1.2.3