git: f55bb91726 - main - [phb][uses] Document erlang

Fernando Apesteguía <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by fernape:

URL: https://cgit.FreeBSD.org/doc/commit/?id=f55bb91726b6ad07362bf8aedb6a3aa9d62bd41f

commit f55bb91726b6ad07362bf8aedb6a3aa9d62bd41f
Author:     Fernando Apesteguía <[email protected]>
AuthorDate: 2022-12-01 07:09:14 +0000
Commit:     Fernando Apesteguía <[email protected]>
CommitDate: 2022-12-08 17:12:40 +0000

    [phb][uses] Document erlang
    
    Document erlang facilities in the ports framework.
    
    Reviewers: dch@, olgeni@
    Differential Revision: https://reviews.freebsd.org/D37578
---
 .../en/books/porters-handbook/uses/_index.adoc     | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index dad36f57b2..cfa218a8b9 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -425,6 +425,29 @@ ELF_FEATURES=	featurelist:path/to/file1 \
 
 The format of `featurelist` is described in man:elfctl[1].  The file paths are relative to ${BUILD_WRKSRC}.
 
+[[uses-erlang]]
+== `erlang`
+
+Possible arguments: (none), `enc`, `rebar`, `rebar3`
+
+Adds a build and run time dependency on package:lang/erlang[].
+Depending on the argument, it adds additional build dependencies. `enc` adds a
+dependency on package:devel/erlang-native-compiler[], `rebar` adds a dependency on
+package:devel/rebar[] and `rebar3` adds a dependency on package:devel/rebar3[].
+
+In addition, the following variables are available to the port:
+
+* `ERL_APP_NAME`: Erlang app name as installed in Erlang's lib dir (minus version)
+* `ERL_APP_ROOT`: Root directory for this Erlang app
+* `REBAR_CMD`: Path to the "rebar" command
+* `REBAR3_CMD`: Path to the "rebar3" command
+* `REBAR_PROFILE`: Rebar profile
+* `REBAR_TARGETS`: Rebar target list (usually compile, maybe escriptize)
+* `ERL_BUILD_NAME`: Build name for rebar3
+* `ERL_BUILD_DEPS`: List of BUILD_DEPENDS in category/portname format
+* `ERL_RUN_DEPS`: List of RUN_DEPENDS in category/portname format
+* `ERL_DOCS`: List of documentation files and directories
+
 [[uses-fakeroot]]
 == `fakeroot`
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.