From a1e28d3740c921e303cb0a75953a6f44fef4e7c1 Mon Sep 17 00:00:00 2001 From: "Bryan A. S" Date: Mon, 22 Mar 2021 20:06:40 -0300 Subject: [PATCH] doc/builders/packages/dlib.xml: Convert to markdown Signed-off-by: Bryan A. S --- doc/builders/packages/dlib.section.md | 13 +++++++++++++ doc/builders/packages/dlib.xml | 24 ------------------------ doc/builders/packages/index.xml | 2 +- 3 files changed, 14 insertions(+), 25 deletions(-) create mode 100644 doc/builders/packages/dlib.section.md delete mode 100644 doc/builders/packages/dlib.xml diff --git a/doc/builders/packages/dlib.section.md b/doc/builders/packages/dlib.section.md new file mode 100644 index 000000000000..8f0aa8610180 --- /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 5f768dd51b62..000000000000 --- a/doc/builders/packages/dlib.xml +++ /dev/null @@ -1,24 +0,0 @@ -
- DLib - - - DLib is a modern, C++-based toolkit which provides several machine learning algorithms. - - -
- Compiling without AVX support - - - Especially older CPUs don't support AVX (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: -self: super: { - dlib = super.dlib.override { avxSupport = false; }; -} - -
-
diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml index a2bcd4315311..f5b05b0bbccf 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. - +