diff options
| author | AndersonTorres <torres.anderson.85@protonmail.com> | 2020-12-13 15:47:22 -0300 |
|---|---|---|
| committer | AndersonTorres <torres.anderson.85@protonmail.com> | 2020-12-16 14:51:43 -0300 |
| commit | 23d578477077834b56e64d084353bfe48d09adf8 (patch) | |
| tree | a2a930c17a8dbf53d2a8cd7bd244735a2e5f345f | |
| parent | de8205f8bb2c6ca14730b00ba3a280db1d364b40 (diff) | |
| download | nixpkgs-23d578477077834b56e64d084353bfe48d09adf8.tar nixpkgs-23d578477077834b56e64d084353bfe48d09adf8.tar.gz nixpkgs-23d578477077834b56e64d084353bfe48d09adf8.tar.bz2 nixpkgs-23d578477077834b56e64d084353bfe48d09adf8.tar.lz nixpkgs-23d578477077834b56e64d084353bfe48d09adf8.tar.xz nixpkgs-23d578477077834b56e64d084353bfe48d09adf8.tar.zst nixpkgs-23d578477077834b56e64d084353bfe48d09adf8.zip | |
Convert mkShell from DocBook to CommonMark
| -rw-r--r-- | doc/builders/special.xml | 2 | ||||
| -rw-r--r-- | doc/builders/special/mkshell.section.md | 15 | ||||
| -rw-r--r-- | doc/builders/special/mkshell.xml | 24 |
3 files changed, 16 insertions, 25 deletions
diff --git a/doc/builders/special.xml b/doc/builders/special.xml index 15fdba9a041..09115751d6a 100644 --- a/doc/builders/special.xml +++ b/doc/builders/special.xml @@ -6,5 +6,5 @@ This chapter describes several special builders. </para> <xi:include href="special/fhs-environments.xml" /> - <xi:include href="special/mkshell.xml" /> + <xi:include href="special/mkshell.section.xml" /> </chapter> diff --git a/doc/builders/special/mkshell.section.md b/doc/builders/special/mkshell.section.md new file mode 100644 index 00000000000..1feb75cbd6f --- /dev/null +++ b/doc/builders/special/mkshell.section.md @@ -0,0 +1,15 @@ +# pkgs.mkShell {#sec-pkgs-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 {#sec-pkgs-mkShell-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 ]; +} +``` diff --git a/doc/builders/special/mkshell.xml b/doc/builders/special/mkshell.xml deleted file mode 100644 index cef65d06b88..00000000000 --- a/doc/builders/special/mkshell.xml +++ /dev/null @@ -1,24 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xml:id="sec-pkgs-mkShell"> - <title>pkgs.mkShell</title> - - <para> - <function>pkgs.mkShell</function> is a special kind of derivation that is only useful when using it combined with <command>nix-shell</command>. It will in fact fail to instantiate when invoked with <command>nix-build</command>. - </para> - - <section xml:id="sec-pkgs-mkShell-usage"> - <title>Usage</title> - -<programlisting><![CDATA[ -{ 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 ]; -} -]]></programlisting> - </section> -</section> |