diff options
| author | Ryan Mulligan <ryan@ryantm.com> | 2021-06-06 07:45:53 -0700 |
|---|---|---|
| committer | Ryan Mulligan <ryan@ryantm.com> | 2021-06-07 19:56:38 -0700 |
| commit | fbfdc8fc0b9ad81115e86cc48f97dc666d57b444 (patch) | |
| tree | 136f46609e7438680a6f514cd278ce2d633786d0 /doc/functions | |
| parent | c43e0f48735f2e839b656b7b1ec792babeed6a15 (diff) | |
doc/functions/debug: convert to CommonMark
Diffstat (limited to 'doc/functions')
| -rw-r--r-- | doc/functions/debug.section.md | 5 | ||||
| -rw-r--r-- | doc/functions/debug.xml | 14 |
2 files changed, 5 insertions, 14 deletions
diff --git a/doc/functions/debug.section.md b/doc/functions/debug.section.md new file mode 100644 index 000000000000..b2d8589431ab --- /dev/null +++ b/doc/functions/debug.section.md @@ -0,0 +1,5 @@ +# Debugging Nix Expressions {#sec-debug} + +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. + +In the `lib/debug.nix` file you will find a number of functions that help (pretty-)printing values while evaluation is running. You can even specify how deep these values should be printed recursively, and transform them on the fly. Please consult the docstrings in `lib/debug.nix` for usage information. diff --git a/doc/functions/debug.xml b/doc/functions/debug.xml deleted file mode 100644 index c27421f12e76..000000000000 --- a/doc/functions/debug.xml +++ /dev/null @@ -1,14 +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-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> |