summary refs log tree commit diff
path: root/doc/functions/debug.section.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/debug.section.md')
-rw-r--r--doc/functions/debug.section.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/functions/debug.section.md b/doc/functions/debug.section.md
new file mode 100644
index 00000000000..b2d8589431a
--- /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.