diff options
| author | Graham Christensen <graham@grahamc.com> | 2018-10-02 14:07:06 -0400 |
|---|---|---|
| committer | Graham Christensen <graham@grahamc.com> | 2018-10-02 14:07:06 -0400 |
| commit | 3ac79c89b7da1f674c742f6a30385d37454e7f62 (patch) | |
| tree | e3fe69d703edf2612772b7ec16743d305c178e72 /doc | |
| parent | 9ae39b3553146b3ae72fc5ac26654e1930baba3d (diff) | |
| download | nixlib-3ac79c89b7da1f674c742f6a30385d37454e7f62.tar nixlib-3ac79c89b7da1f674c742f6a30385d37454e7f62.tar.gz nixlib-3ac79c89b7da1f674c742f6a30385d37454e7f62.tar.bz2 nixlib-3ac79c89b7da1f674c742f6a30385d37454e7f62.tar.lz nixlib-3ac79c89b7da1f674c742f6a30385d37454e7f62.tar.xz nixlib-3ac79c89b7da1f674c742f6a30385d37454e7f62.tar.zst nixlib-3ac79c89b7da1f674c742f6a30385d37454e7f62.zip | |
nixpkgs docs: move debug to its own file
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/functions.xml | 19 | ||||
| -rw-r--r-- | doc/functions/debug.xml | 21 |
2 files changed, 22 insertions, 18 deletions
diff --git a/doc/functions.xml b/doc/functions.xml index 333ed65986b1..b710d30e1081 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -10,24 +10,7 @@ <xi:include href="functions/overrides.xml" /> <xi:include href="functions/generators.xml" /> - <section xml:id="sec-debug"> - <title>Debugging Nix Expressions</title> - - <para> - Nix is a unityped, dynamic language, this means every value can potentially - appear anywhere. Since it is also non-strict, evaluation order and what - ultimately is evaluated might surprise you. Therefore it is important to be - able to debug nix expressions. - </para> - - <para> - In the <literal>lib/debug.nix</literal> file you will find a number of - functions that help (pretty-)printing values while evaluation is runnnig. - You can even specify how deep these values should be printed recursively, - and transform them on the fly. Please consult the docstrings in - <literal>lib/debug.nix</literal> for usage information. - </para> - </section> + <xi:include href="functions/debug.xml" /> <section xml:id="sec-fhs-environments"> <title>buildFHSUserEnv</title> diff --git a/doc/functions/debug.xml b/doc/functions/debug.xml new file mode 100644 index 000000000000..272bdf55513f --- /dev/null +++ b/doc/functions/debug.xml @@ -0,0 +1,21 @@ +<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-debug"> + <title>Debugging Nix Expressions</title> + + <para> + Nix is a unityped, dynamic language, this means every value can potentially + appear anywhere. Since it is also non-strict, evaluation order and what + ultimately is evaluated might surprise you. Therefore it is important to be + able to debug nix expressions. + </para> + + <para> + In the <literal>lib/debug.nix</literal> file you will find a number of + functions that help (pretty-)printing values while evaluation is runnnig. + You can even specify how deep these values should be printed recursively, + and transform them on the fly. Please consult the docstrings in + <literal>lib/debug.nix</literal> for usage information. + </para> + </section> |