[pygobject] docs: update building/testing with new setup.py features
- From: Christoph Reiter <creiter src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pygobject] docs: update building/testing with new setup.py features
- Date: Wed, 7 Feb 2018 10:57:00 +0000 (UTC)
commit 1330712bcf8109090bacf0cdfbba0c2a47930ac9
Author: Christoph Reiter <reiter christoph gmail com>
Date: Wed Feb 7 09:35:08 2018 +0100
docs: update building/testing with new setup.py features
docs/devguide/building_testing.rst | 45 +++++++++++++++++++++-----------------
1 file changed, 25 insertions(+), 20 deletions(-)
---
diff --git a/docs/devguide/building_testing.rst b/docs/devguide/building_testing.rst
index 901f3ea4..f3ac215a 100644
--- a/docs/devguide/building_testing.rst
+++ b/docs/devguide/building_testing.rst
@@ -5,50 +5,55 @@ Building & Testing
Using Autotools
---------------
-Building for Python 2:
-
-::
+.. code:: shell
+ # Building for Python 2
./autogen.sh --with-python=python2
make
-Building for Python 3:
-
-::
-
+ # Building for Python 3
./autogen.sh --with-python=python3
make
+ # Executing some code after the build
+ PYTHONPATH=. python3 foo.py
-To run the test suite::
-
+ # To run the test suite
make check
-To test only a specific file/class/function::
-
+ # To test only a specific file/class/function::
make check TEST_NAMES=test_gi
make check TEST_NAMES=test_gi.TestUtf8
make check TEST_NAMES=test_gi.TestUtf8.test_utf8_full_return
-To execute all the tests in a gdb session::
-
+ # To execute all the tests in a gdb session
make check.gdb
-To executes all the tests in valgrind::
-
+ # To executes all the tests in valgrind
make check.valgrind
-To execute flake8 tests::
-
+ # To execute flake8 tests
make check.quality
Using Setuptools
----------------
-Building and testing in the source directory:
+.. code:: shell
+
+ # Build in-tree
+ python3 setup.py build_ext --inplace
-::
+ # Executing some code after the build
+ PYTHONPATH=. python3 foo.py
- python2 setup.py test
+ # Running tests
python3 setup.py test
+
+ # To test only a specific file/class/function::
+ TEST_NAMES=test_gi python3 python3 setup.py test
+ TEST_NAMES=test_gi.TestUtf8 python3 setup.py test
+ TEST_NAMES=test_gi.TestUtf8.test_utf8_full_return python3 setup.py test
+
+ # Running flake8 tests
+ python3 setup.py quality
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]