From: Paul Brossier <piem@piem.org>
Date: Fri, 16 Dec 2016 11:26:48 +0000 (+0100)
Subject: doc/requirements.rst: add a note about --notests (closes #77)
X-Git-Tag: 0.4.4~56
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=9682d9d2d200d514f372ff3317f3445e2b5d2477;p=aubio.git

doc/requirements.rst: add a note about --notests (closes #77)
---

diff --git a/doc/requirements.rst b/doc/requirements.rst
index d2b4bde2..8a74eb0a 100644
--- a/doc/requirements.rst
+++ b/doc/requirements.rst
@@ -204,6 +204,19 @@ To compile aubio in double precision mode, configure with ``--enable-double``.
 
 To compile aubio in single precision mode, use ``--disable-double`` (default).
 
+Disabling the tests
+...................
+
+In some case, for instance when cross-compiling, unit tests should not be run.
+Option ``--notests`` can be used for this purpose. The tests will not be
+executed, but the binaries will be compiled, ensuring that linking against
+libaubio works as expected.
+
+.. note::
+
+  The ``--notests`` option should be passed to both ``build`` and ``install``
+  targets, otherwise waf will try to run them.
+
 Edit wscript
 ............