Changeset 9682d9d for doc

Timestamp:

Dec 16, 2016, 12:26:48 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, sampler, yinfft+

Children:

3388e1a

Parents:

1910fed

Message:

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

File:

• doc/requirements.rst (modified) (1 diff)

doc/requirements.rst

@@ -205 +205 @@
 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
 ............