summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorDavid <dlesl@users.noreply.github.com>2021-05-08 13:18:00 +0200
committerRaphael Megzari <raphael@megzari.com>2021-05-11 08:59:57 +0900
commitaaa16732ce3d3001e238eb4074cd68b8f300f77f (patch)
tree47557687f3bf56e48ac1a47f346b2ae850387ad2 /doc
parentac5ef3c55ff886e3318f5c2b806b1b33201afd50 (diff)
downloadnixpkgs-aaa16732ce3d3001e238eb4074cd68b8f300f77f.tar
nixpkgs-aaa16732ce3d3001e238eb4074cd68b8f300f77f.tar.gz
nixpkgs-aaa16732ce3d3001e238eb4074cd68b8f300f77f.tar.bz2
nixpkgs-aaa16732ce3d3001e238eb4074cd68b8f300f77f.tar.lz
nixpkgs-aaa16732ce3d3001e238eb4074cd68b8f300f77f.tar.xz
nixpkgs-aaa16732ce3d3001e238eb4074cd68b8f300f77f.tar.zst
nixpkgs-aaa16732ce3d3001e238eb4074cd68b8f300f77f.zip
rebar3: add rebar3WithPlugins
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/beam.section.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/languages-frameworks/beam.section.md b/doc/languages-frameworks/beam.section.md
index b5d39595c10..947968db15e 100644
--- a/doc/languages-frameworks/beam.section.md
+++ b/doc/languages-frameworks/beam.section.md
@@ -24,6 +24,10 @@ Many Erlang/OTP distributions available in `beam.interpreters` have versions wit
 
 We provide a version of Rebar3, under `rebar3`. We also provide a helper to fetch Rebar3 dependencies from a lockfile under `fetchRebar3Deps`.
 
+We also provide a version on Rebar3 with plugins included, under `rebar3WithPlugins`. This package is a function which takes two arguments: `plugins`, a list of nix derivations to include as plugins (loaded only when specified in `rebar.config`), and `globalPlugins`, which should always be loaded by rebar3. Example: `rebar3WithPlugins { globalPlugins = [beamPackages.pc]; }`.
+
+When adding a new plugin it is important that the `packageName` attribute is the same as the atom used by rebar3 to refer to the plugin.
+
 ### Mix & Erlang.mk {#build-tools-other}
 
 Erlang.mk works exactly as expected. There is a bootstrap process that needs to be run, which is supported by the `buildErlangMk` derivation.