summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2017-11-07 12:40:04 +0100
committerGitHub <noreply@github.com>2017-11-07 12:40:04 +0100
commitb028c41014921cde824ed3b3208143e2369f9c63 (patch)
treee09da95c20fc274ed5992203ecaf11a6066f0016
parenta1ae4e38503eb8a55712b6cd1f9d958035b0fd38 (diff)
Clean up the test suite section a bit more
-rw-r--r--README.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.rst b/README.rst
index 4f85da7..f08eafd 100644
--- a/README.rst
+++ b/README.rst
@@ -313,19 +313,20 @@ The test suite is run with
$ python(3) Kconfiglib/testsuite.py
-(`pypy <http://pypy.org>`_ works too, and is much speedier for everything except ``allnoconfig.py``/``allnoconfig_simpler.py``/``allyesconfig.py``, where it doesn't have time to warm up since
-the scripts are run via ``make scriptconfig``.)
+`pypy <http://pypy.org>`_ works too, and is much speedier for everything except ``allnoconfig.py``/``allnoconfig_simpler.py``/``allyesconfig.py``, where it doesn't have time to warm up since
+the scripts are run via ``make scriptconfig``.
-The test suite must be run from the top-level kernel directory, and requires that the git
-repository has been cloned into it and that the makefile patch has been applied.
+The test suite must be run from the top-level kernel directory. It requires that the
+Kconfiglib git repository has been cloned into it and that the makefile patch has been applied.
**NOTE: The test suite overwrites .config in the kernel root, so make sure to back it up.**
The test suite consists of a set of selftests and a set of compatibility tests that
-compare (character for character) configurations generated by Kconfiglib with
-configurations generated by ``scripts/kconfig/conf`` for a number of cases. You
-might want to use the "speedy" option; see
-`testsuite.py <https://github.com/ulfalizer/Kconfiglib/blob/master/testsuite.py>`_.
+compare configurations generated by Kconfiglib with
+configurations generated by the C tools, for a number of cases. See
+`testsuite.py <https://github.com/ulfalizer/Kconfiglib/blob/master/testsuite.py>`_
+for the available options. You might want to use the "speedy" option to speed things
+up a bit.
The test suite might fail for a few configurations for kernels older than April 2016,
when a fix was added to Kconfig that's also mirrored in Kconfiglib
@@ -333,8 +334,9 @@ when a fix was added to Kconfig that's also mirrored in Kconfiglib
This is harmless, and only counts as a fail since the test suite compares literal
output from the kconfig version that's bundled with the kernel.
-A lot of the time is spent waiting around for ``make`` and the C utilities (which need to reparse all the
-Kconfig files for each defconfig test). Adding some multiprocessing to the test suite would make sense.
+A lot of time is spent waiting around for ``make`` and the C utilities (which need to reparse all the
+Kconfig files for each defconfig test). Adding some multiprocessing to the test suite would make sense
+too.
Notes
-----