diff options
author | Yueh-Shun Li <shamrocklee@posteo.net> | 2023-06-03 19:05:54 +0000 |
---|---|---|
committer | Yueh-Shun Li <shamrocklee@posteo.net> | 2023-11-07 19:58:53 +0000 |
commit | 9963ad5c5fbbe55fb310e9477cab2fa685afaac2 (patch) | |
tree | df313f78c6f9a130173f87df4603693686dbcb1e /doc/builders/special/mkshell.section.md | |
parent | 70f21a213651a0f4149bea10721fea04485c8a80 (diff) | |
download | nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.gz nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.bz2 nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.lz nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.xz nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.tar.zst nixpkgs-9963ad5c5fbbe55fb310e9477cab2fa685afaac2.zip |
doc: builders -> build helpers to reduce ambigualty
Diffstat (limited to 'doc/builders/special/mkshell.section.md')
-rw-r--r-- | doc/builders/special/mkshell.section.md | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/doc/builders/special/mkshell.section.md b/doc/builders/special/mkshell.section.md deleted file mode 100644 index 96d43535955..00000000000 --- a/doc/builders/special/mkshell.section.md +++ /dev/null @@ -1,37 +0,0 @@ -# pkgs.mkShell {#sec-pkgs-mkShell} - -`pkgs.mkShell` is a specialized `stdenv.mkDerivation` that removes some -repetition when using it with `nix-shell` (or `nix develop`). - -## Usage {#sec-pkgs-mkShell-usage} - -Here is a common usage example: - -```nix -{ pkgs ? import <nixpkgs> {} }: -pkgs.mkShell { - packages = [ pkgs.gnumake ]; - - inputsFrom = [ pkgs.hello pkgs.gnutar ]; - - shellHook = '' - export DEBUG=1 - ''; -} -``` - -## Attributes {#sec-pkgs-mkShell-attributes} - -* `name` (default: `nix-shell`). Set the name of the derivation. -* `packages` (default: `[]`). Add executable packages to the `nix-shell` environment. -* `inputsFrom` (default: `[]`). Add build dependencies of the listed derivations to the `nix-shell` environment. -* `shellHook` (default: `""`). Bash statements that are executed by `nix-shell`. - -... all the attributes of `stdenv.mkDerivation`. - -## Building the shell {#sec-pkgs-mkShell-building} - -This derivation output will contain a text file that contains a reference to -all the build inputs. This is useful in CI where we want to make sure that -every derivation, and its dependencies, build properly. Or when creating a GC -root so that the build dependencies don't get garbage-collected. |