diff options
author | Graham Christensen <graham@grahamc.com> | 2018-10-02 14:13:42 -0400 |
---|---|---|
committer | Graham Christensen <graham@grahamc.com> | 2018-10-02 14:13:42 -0400 |
commit | 507a63c88557f8afa06a3e507fe3d055fc55a815 (patch) | |
tree | 8014f47511e7a1535787ed493242fa56b8891cfc /doc/functions | |
parent | 8bf342ffb86eedf8a9749420b4019ab1e4c21629 (diff) | |
download | nixlib-507a63c88557f8afa06a3e507fe3d055fc55a815.tar nixlib-507a63c88557f8afa06a3e507fe3d055fc55a815.tar.gz nixlib-507a63c88557f8afa06a3e507fe3d055fc55a815.tar.bz2 nixlib-507a63c88557f8afa06a3e507fe3d055fc55a815.tar.lz nixlib-507a63c88557f8afa06a3e507fe3d055fc55a815.tar.xz nixlib-507a63c88557f8afa06a3e507fe3d055fc55a815.tar.zst nixlib-507a63c88557f8afa06a3e507fe3d055fc55a815.zip |
nixpkgs docs: move shell section to its own file
Diffstat (limited to 'doc/functions')
-rw-r--r-- | doc/functions/shell.section.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/functions/shell.section.md b/doc/functions/shell.section.md new file mode 100644 index 000000000000..cb8832a814fc --- /dev/null +++ b/doc/functions/shell.section.md @@ -0,0 +1,22 @@ +--- +title: pkgs.mkShell +author: zimbatm +date: 2017-10-30 +--- + +# mkShell + +pkgs.mkShell is a special kind of derivation that is only useful when using +it combined with nix-shell. It will in fact fail to instantiate when invoked +with nix-build. + +## Usage + +```nix +{ pkgs ? import <nixpkgs> {} }: +pkgs.mkShell { + # this will make all the build inputs from hello and gnutar available to the shell environment + inputsFrom = with pkgs; [ hello gnutar ]; + buildInputs = [ pkgs.gnumake ]; +} +``` |