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 templates
2.7. 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. Compatibility with other build tools
8.1. Rebar projects as Erlang.mk dependencies
8.2. Erlang.mk projects as Rebar dependencies
II. Advanced
9. External plugins
9.1. Loading all plugins from a dependency
9.2. Loading one plugin from a dependency
9.3. Writing external plugins
III. About Erlang.mk
10. Why Erlang.mk
10.1. Erlang.mk is fast
10.2. Erlang.mk gives you the full power of Unix
10.3. Erlang.mk is a text file
10.4. Erlang.mk can manage Erlang itself
10.5. Erlang.mk can do more than Erlang
10.6. Erlang.mk integrates nicely in Make and Automake projects