From adc5c9b83df203c9e425efe00f9a788ed3554c2d Mon Sep 17 00:00:00 2001
From: zimbatm <zimbatm@zimbatm.com>
Date: Wed, 20 Dec 2017 23:42:07 +0000
Subject: mkShell: add builder (#30975)

---
 doc/shell.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 doc/shell.md

(limited to 'doc/shell.md')

diff --git a/doc/shell.md b/doc/shell.md
new file mode 100644
index 0000000000000..a4f999695cbc6
--- /dev/null
+++ b/doc/shell.md
@@ -0,0 +1,20 @@
+---
+title: stdenv.mkShell
+author: zimbatm
+date: 2017-10-30
+---
+
+stdenv.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 ];
+}
+```
-- 
cgit 1.4.1