summary refs log tree commit diff
path: root/doc/builders/packages
diff options
context:
space:
mode:
authorSandro <sandro.jaeckel@gmail.com>2021-04-22 03:35:39 +0200
committerGitHub <noreply@github.com>2021-04-22 03:35:39 +0200
commit9419ed621f99926e6e10416fac050bb7ece9ebdd (patch)
treea9e8b535df669f31af45ffa355d6ff989991e590 /doc/builders/packages
parent227fecc2e7e634d85447f7f0edebfac8e1d38988 (diff)
parenta1e28d3740c921e303cb0a75953a6f44fef4e7c1 (diff)
downloadnixpkgs-9419ed621f99926e6e10416fac050bb7ece9ebdd.tar
nixpkgs-9419ed621f99926e6e10416fac050bb7ece9ebdd.tar.gz
nixpkgs-9419ed621f99926e6e10416fac050bb7ece9ebdd.tar.bz2
nixpkgs-9419ed621f99926e6e10416fac050bb7ece9ebdd.tar.lz
nixpkgs-9419ed621f99926e6e10416fac050bb7ece9ebdd.tar.xz
nixpkgs-9419ed621f99926e6e10416fac050bb7ece9ebdd.tar.zst
nixpkgs-9419ed621f99926e6e10416fac050bb7ece9ebdd.zip
Merge pull request #108919 from bryanasdev000/doc-dlib
dlib: Update doc to use CommonMark
Diffstat (limited to 'doc/builders/packages')
-rw-r--r--doc/builders/packages/dlib.section.md13
-rw-r--r--doc/builders/packages/dlib.xml24
-rw-r--r--doc/builders/packages/index.xml2
3 files changed, 14 insertions, 25 deletions
diff --git a/doc/builders/packages/dlib.section.md b/doc/builders/packages/dlib.section.md
new file mode 100644
index 00000000000..8f0aa861018
--- /dev/null
+++ b/doc/builders/packages/dlib.section.md
@@ -0,0 +1,13 @@
+# DLib {#dlib}
+
+[DLib](http://dlib.net/) is a modern, C++-based toolkit which provides several machine learning algorithms.
+
+## Compiling without AVX support {#compiling-without-avx-support}
+
+Especially older CPUs don\'t support [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) (Advanced Vector Extensions) instructions that are used by DLib to optimize their algorithms.
+
+On the affected hardware errors like `Illegal instruction` will occur. In those cases AVX support needs to be disabled:
+
+```nix
+self: super: { dlib = super.dlib.override { avxSupport = false; }; }
+```
diff --git a/doc/builders/packages/dlib.xml b/doc/builders/packages/dlib.xml
deleted file mode 100644
index 5f768dd51b6..00000000000
--- a/doc/builders/packages/dlib.xml
+++ /dev/null
@@ -1,24 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xml:id="dlib">
- <title>DLib</title>
-
- <para>
-  <link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which provides several machine learning algorithms.
- </para>
-
- <section xml:id="compiling-without-avx-support">
-  <title>Compiling without AVX support</title>
-
-  <para>
-   Especially older CPUs don't support <link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link> (<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by DLib to optimize their algorithms.
-  </para>
-
-  <para>
-   On the affected hardware errors like <literal>Illegal instruction</literal> will occur. In those cases AVX support needs to be disabled:
-<programlisting>self: super: {
-  dlib = super.dlib.override { avxSupport = false; };
-}</programlisting>
-  </para>
- </section>
-</section>
diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml
index a2bcd431531..f5b05b0bbcc 100644
--- a/doc/builders/packages/index.xml
+++ b/doc/builders/packages/index.xml
@@ -6,7 +6,7 @@
   This chapter contains information about how to use and maintain the Nix expressions for a number of specific packages, such as the Linux kernel or X.org.
  </para>
  <xi:include href="citrix.section.xml" />
- <xi:include href="dlib.xml" />
+ <xi:include href="dlib.section.xml" />
  <xi:include href="eclipse.section.xml" />
  <xi:include href="elm.section.xml" />
  <xi:include href="emacs.section.xml" />