From ca2511f4f9b3e692a30f49a59053518b6d6007c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 19 Nov 2024 21:13:21 +0100 Subject: Update user guide --- guide/deps.html | 10 +++++----- guide/getting_started.html | 3 ++- 2 files changed, 7 insertions(+), 6 deletions(-) (limited to 'guide') diff --git a/guide/deps.html b/guide/deps.html index fe08502..0d5945c 100644 --- a/guide/deps.html +++ b/guide/deps.html @@ -93,12 +93,12 @@ variable. There are two ways to do this, each being useful for different reasons.

If you simply want to change the commit number, all you need to do is to define the dep_$(DEP_NAME)_commit variable. In the case of Cowboy, this would look like this:

DEPS = cowboy
-dep_cowboy_commit = 2.0.0-pre.2

Erlang.mk will use the package index to get all information +dep_cowboy_commit = 2.12.0

Erlang.mk will use the package index to get all information about Cowboy, except the commit number which will be overridden.

If you need to set the fetch method or repository information too, for example because you want to use your own fork, or simply because the project is missing from the index, you can define the dep_$(DEP_NAME) variable with everything:

DEPS = cowboy
-dep_cowboy = git https://github.com/essen/cowboy 2.0.0-pre.2

This will fetch Cowboy from your fork at the given commit.

7.2.2. Fetch methods

Erlang.mk comes with a number of different fetch methods. +dep_cowboy = git https://github.com/essen/cowboy 2.12.0

This will fetch Cowboy from your fork at the given commit.

7.2.2. Fetch methods

Erlang.mk comes with a number of different fetch methods. You can fetch from Git, Mercurial, SVN, to name a few. There are fetch methods that will work everywhere, and fetch methods that will only work in a given environment.

The following table lists all existing methods:

Name Format Description

git

git repo commit

Clone the Git repository and checkout the given version

git-subfolder

git repo commit subfolder

Clone the Git repository, checkout the given version and use one of its subfolders as a dependency

git-submodule

git-submodule

Initialize and update the Git submodule

hg

hg repo commit

Clone the Mercurial repository and update to the given version

svn

svn repo

Checkout the given SVN repository

cp

cp path/to/repo

Recursively copy a local directory

ln

ln path/to/repo

Symbolically link a local directory

hex

hex version [pkg]

Download the given project version from hex.pm

fail

N/A

Always fail, reserved for internal use

legacy

N/A

Legacy Erlang.mk fetcher, reserved for internal use

default

N/A

Reserved

The git and hg methods both have a repository and commit. @@ -115,11 +115,11 @@ you can provide it after the version:

dep_uuid =
 define your own. Erlang.mk will consider all variables that
 are named as dep_fetch_$(METHOD) to be available fetch
 methods. You can do anything inside this variable, as long
-as you create a folder named $(DEPS_DIR)/$(call dep_name,$1).
+as you create a folder named $(DEPS_DIR)/$(call query_name,$1).
 Or in layman terms, if your dependency is Cowboy, this would
 become deps/cowboy.
To give an example, this is what the Git method does:
define dep_fetch_git
-    git clone -q -n -- $(call dep_repo,$1) $(DEPS_DIR)/$(call dep_name,$1); \
-    cd $(DEPS_DIR)/$(call dep_name,$1) && git checkout -q $(call dep_commit,$1);
+    git clone -q -n -- $(call query_repo_git,$1) $(DEPS_DIR)/$(call query_name,$1); \
+    cd $(DEPS_DIR)/$(call query_name,$1) && git checkout -q $(call query_version_git,$1);
 endef
Note that, like dependency information, this custom fetch method
 must be written before including erlang.mk.

7.3. How deps are fetched and built

The order in which dependencies are fetched and built is well defined. This means that Erlang.mk will get the same applications diff --git a/guide/getting_started.html b/guide/getting_started.html index ecb66d0..7369da2 100644 --- a/guide/getting_started.html +++ b/guide/getting_started.html @@ -183,7 +183,8 @@ Bootstrap targets: list-templates List available templates ...

This guide should provide any other answer. If not, please open a ticket on the official repository -and we will work on improving the guide.

Commercial support is available through Nine Nines. Please contact +and we will work on improving the guide. For any other questions, +please visit the erlang-mk channel on Discord.

Commercial support is available through Nine Nines. Please contact Loïc Hoguin by sending an email to contact@ninenines.eu.

Prev   Next
 Home 
-- cgit v1.2.3