From 5f5cc27daba68f27901faac83876dd99d3d593ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 5 Jul 2018 13:09:52 +0200 Subject: Update user guide --- guide/index.html | 2 +- guide/updating.html | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/guide/index.html b/guide/index.html index a1c85a0..a9c5ce7 100644 --- a/guide/index.html +++ b/guide/index.html @@ -33,7 +33,7 @@ div.navfooter{margin-bottom:1em}
-
   Next

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. Getting started from scratch
2.7. Using spaces instead of tabs
2.8. Using templates
2.9. Hiding Erlang.mk from git
2.10. 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. Fetching and listing dependencies only
7.5. Ignoring unwanted dependencies
7.6. Dependencies directory
7.7. Many applications in one repository
7.8. Repositories with no application at the root level
7.9. Autopatch
7.10. 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
8.4. Propagating compile and linker flags to sub-Makefiles
9. Releases
9.1. Setup
9.2. Configuration
9.3. Generating the release
9.4. Running the release
9.5. Upgrading a release
9.6. Getting Relx semver value
10. Self-extracting releases
10.1. Generating the self-extracting archive
10.2. Running the release
11. Escripts
11.1. Requirements
11.2. Generating an escript
11.3. Configuration
11.4. Extra files
11.5. Optimizing for size
12. OTP version management
12.1. Erlang versions
12.2. OTP version pinning
12.3. Continuous integration
12.4. Configuring Kerl
13. Compatibility with other build tools
13.1. Rebar projects as Erlang.mk dependencies
13.2. Erlang.mk projects as Rebar dependencies
II. Documentation
14. AsciiDoc documentation
14.1. Requirements
14.2. Writing AsciiDoc documentation
14.3. Configuration
14.4. Usage
15. EDoc comments
15.1. Writing EDoc comments
15.2. Configuration
15.3. Usage
16. Sphinx documentation
16.1. Writing Sphinx documentation
16.2. Basic setup
16.3. Erlang.mk configuration
16.4. Generating man pages
III. Tests
17. Erlang shell
17.1. Configuration
17.2. Usage
18. EUnit
18.1. Writing tests
18.2. Configuration
18.3. Usage
19. Common Test
19.1. Writing tests
19.2. Configuration
19.3. Usage
20. Triq
21. Code coverage
22. Continuous integration
22.1. Configuring Erlang/OTP versions to test
22.2. Running tests across all configured versions
22.3. Extending the CI targets
23. Dialyzer
23.1. How it works
23.2. Configuration
23.3. Usage
24. Xref
IV. Third-party plugins
25. External plugins
25.1. Loading all plugins from a dependency
25.2. Loading one plugin from a dependency
25.3. Writing external plugins
25.4. Early-stage plugins
25.5. Loading plugins local to the application
26. List of plugins
26.1. efene.mk
26.2. elixir.mk
26.3. elvis.mk
26.4. geas
26.5. hexer.mk
26.6. hexpm.mk
26.7. jorel
26.8. lfe.mk
26.9. mix.mk
26.10. reload.mk
26.11. rust.mk
V. About Erlang.mk
27. Why Erlang.mk
27.1. Erlang.mk is fast
27.2. Erlang.mk gives you the full power of Unix
27.3. Erlang.mk is a text file
27.4. Erlang.mk can manage Erlang itself
27.5. Erlang.mk can do more than Erlang
27.6. Erlang.mk integrates nicely in Make and Automake projects
28. Short history
28.1. Before Erlang.mk
28.2. Lifetime of the project
29. Contributing
29.1. Priorities
29.2. Bugs
29.3. Code
29.4. Packages
29.5. Documentation
29.6. Feature requests
   Next
+
   Next

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. Getting started from scratch
2.7. Using spaces instead of tabs
2.8. Using templates
2.9. Hiding Erlang.mk from git
2.10. 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. Fetching and listing dependencies only
7.5. Ignoring unwanted dependencies
7.6. Dependencies directory
7.7. Many applications in one repository
7.8. Repositories with no application at the root level
7.9. Autopatch
7.10. 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
8.4. Propagating compile and linker flags to sub-Makefiles
9. Releases
9.1. Setup
9.2. Configuration
9.3. Generating the release
9.4. Running the release
9.5. Upgrading a release
9.6. Getting Relx semver value
10. Self-extracting releases
10.1. Generating the self-extracting archive
10.2. Running the release
11. Escripts
11.1. Requirements
11.2. Generating an escript
11.3. Configuration
11.4. Extra files
11.5. Optimizing for size
12. OTP version management
12.1. Erlang versions
12.2. OTP version pinning
12.3. Continuous integration
12.4. Configuring Kerl
13. Compatibility with other build tools
13.1. Rebar projects as Erlang.mk dependencies
13.2. Erlang.mk projects as Rebar dependencies
II. Documentation
14. AsciiDoc documentation
14.1. Requirements
14.2. Writing AsciiDoc documentation
14.3. Configuration
14.4. Usage
15. EDoc comments
15.1. Writing EDoc comments
15.2. Configuration
15.3. Usage
16. Sphinx documentation
16.1. Writing Sphinx documentation
16.2. Basic setup
16.3. Erlang.mk configuration
16.4. Generating man pages
III. Tests
17. Erlang shell
17.1. Configuration
17.2. Usage
18. EUnit
18.1. Writing tests
18.2. Configuration
18.3. Usage
19. Common Test
19.1. Writing tests
19.2. Configuration
19.3. Usage
20. Triq
21. Code coverage
22. Continuous integration
22.1. Configuring Erlang/OTP versions to test
22.2. Running tests across all configured versions
22.3. Extending the CI targets
23. Dialyzer
23.1. How it works
23.2. Configuration
23.3. Usage
24. Xref
IV. Third-party plugins
25. External plugins
25.1. Loading all plugins from a dependency
25.2. Loading one plugin from a dependency
25.3. Writing external plugins
25.4. Early-stage plugins
25.5. Loading plugins local to the application
26. List of plugins
26.1. efene.mk
26.2. elixir.mk
26.3. elvis.mk
26.4. geas
26.5. hexer.mk
26.6. hexpm.mk
26.7. jorel
26.8. lfe.mk
26.9. mix.mk
26.10. reload.mk
26.11. rust.mk
V. About Erlang.mk
27. Why Erlang.mk
27.1. Erlang.mk is fast
27.2. Erlang.mk gives you the full power of Unix
27.3. Erlang.mk is a text file
27.4. Erlang.mk can manage Erlang itself
27.5. Erlang.mk can do more than Erlang
27.6. Erlang.mk integrates nicely in Make and Automake projects
28. Short history
28.1. Before Erlang.mk
28.2. Lifetime of the project
29. Contributing
29.1. Priorities
29.2. Bugs
29.3. Code
29.4. Packages
29.5. Documentation
29.6. Feature requests
   Next
diff --git a/guide/updating.html b/guide/updating.html index 7c53495..6d8e386 100644 --- a/guide/updating.html +++ b/guide/updating.html @@ -71,7 +71,9 @@ the ERLANG_MK_BUILD_CONFIG. You can also tell Erlang.mk to use a different temporary directory by changing -the ERLANG_MK_BUILD_DIR variable.

Prev   Next
 Home 
+the ERLANG_MK_BUILD_DIR variable.

If you want to use a different repository or a specific commit for +updating, you may use the variables ERLANG_MK_REPO and +ERLANG_MK_COMMIT.

Prev   Next
 Home 
-- cgit v1.2.3