summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorRyan Mulligan <ryan@ryantm.com>2021-06-07 19:57:22 -0700
committerGitHub <noreply@github.com>2021-06-07 19:57:22 -0700
commite560790890eeba3b81a73bcd3c77d90e76e83e64 (patch)
treecd5106fa69de704d9ce3e7e78ea59563d40af757 /doc
parente3a6ff5f0deec845711cdeb7fd049f319ef127de (diff)
parentfbfdc8fc0b9ad81115e86cc48f97dc666d57b444 (diff)
downloadnixpkgs-e560790890eeba3b81a73bcd3c77d90e76e83e64.tar
nixpkgs-e560790890eeba3b81a73bcd3c77d90e76e83e64.tar.gz
nixpkgs-e560790890eeba3b81a73bcd3c77d90e76e83e64.tar.bz2
nixpkgs-e560790890eeba3b81a73bcd3c77d90e76e83e64.tar.lz
nixpkgs-e560790890eeba3b81a73bcd3c77d90e76e83e64.tar.xz
nixpkgs-e560790890eeba3b81a73bcd3c77d90e76e83e64.tar.zst
nixpkgs-e560790890eeba3b81a73bcd3c77d90e76e83e64.zip
Merge pull request #125957 from ryantm/md-debug
doc/functions/debug: convert to CommonMark
Diffstat (limited to 'doc')
-rw-r--r--doc/functions.xml2
-rw-r--r--doc/functions/debug.section.md5
-rw-r--r--doc/functions/debug.xml14
3 files changed, 6 insertions, 15 deletions
diff --git a/doc/functions.xml b/doc/functions.xml
index e8ab8d97b91..f2d06402317 100644
--- a/doc/functions.xml
+++ b/doc/functions.xml
@@ -8,7 +8,7 @@
  </para>
  <xi:include href="functions/library.xml" />
  <xi:include href="functions/generators.xml" />
- <xi:include href="functions/debug.xml" />
+ <xi:include href="functions/debug.section.xml" />
  <xi:include href="functions/prefer-remote-fetch.xml" />
  <xi:include href="functions/nix-gitignore.section.xml" />
 </chapter>
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.
diff --git a/doc/functions/debug.xml b/doc/functions/debug.xml
deleted file mode 100644
index c27421f12e7..00000000000
--- 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>