diff options
author | Valentin Gagarin <valentin.gagarin@tweag.io> | 2023-09-18 16:34:30 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-18 16:34:30 +0200 |
commit | e2c25280758d6d5b03de9ae69f4431e5a588afa4 (patch) | |
tree | 1eadc47a005ff3707aded41614b58f5559dc9097 | |
parent | c62b4a053c6a01b13a96153d9db327a6b38a9821 (diff) | |
download | nixpkgs-e2c25280758d6d5b03de9ae69f4431e5a588afa4.tar nixpkgs-e2c25280758d6d5b03de9ae69f4431e5a588afa4.tar.gz nixpkgs-e2c25280758d6d5b03de9ae69f4431e5a588afa4.tar.bz2 nixpkgs-e2c25280758d6d5b03de9ae69f4431e5a588afa4.tar.lz nixpkgs-e2c25280758d6d5b03de9ae69f4431e5a588afa4.tar.xz nixpkgs-e2c25280758d6d5b03de9ae69f4431e5a588afa4.tar.zst nixpkgs-e2c25280758d6d5b03de9ae69f4431e5a588afa4.zip |
BEAM docs: recommend `nix-shell -p` and `shell.nix` instead of `nix-env` (#255131)
* BEAM docs: recommend `nix-shell -p` and `shell.nix` instead of `nix-env` Co-authored-by: asymmetric <lorenzo@mailbox.org>
-rw-r--r-- | doc/languages-frameworks/beam.section.md | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/languages-frameworks/beam.section.md b/doc/languages-frameworks/beam.section.md index 5e85723085c..2cb4863fc53 100644 --- a/doc/languages-frameworks/beam.section.md +++ b/doc/languages-frameworks/beam.section.md @@ -44,11 +44,29 @@ There is also a `buildMix` helper, whose behavior is closer to that of `buildErl ## How to Install BEAM Packages {#how-to-install-beam-packages} -BEAM builders are not registered at the top level, simply because they are not relevant to the vast majority of Nix users. To install any of those builders into your profile, refer to them by their attribute path `beamPackages.rebar3`: +BEAM builders are not registered at the top level, simply because they are not relevant to the vast majority of Nix users. +To use any of those builders into your environment, refer to them by their attribute path under `beamPackages`, e.g. `beamPackages.rebar3`: + +::: {.example #ex-beam-ephemeral-shell} +# Ephemeral shell ```ShellSession -$ nix-env -f "<nixpkgs>" -iA beamPackages.rebar3 +$ nix-shell -p beamPackages.rebar3 +``` +::: + +::: {.example #ex-beam-declarative-shell} +# Declarative shell + +```nix +let + pkgs = import <nixpkgs> { config = {}; overlays = []; }; +in +pkgs.mkShell { + packages = [ pkgs.beamPackages.rebar3 ]; +} ``` +::: ## Packaging BEAM Applications {#packaging-beam-applications} |