summaryrefslogtreecommitdiff
path: root/build.txt
diff options
context:
space:
mode:
authorFred Wright <fw@fwright.net>2016-03-15 16:52:09 -0700
committerEric S. Raymond <esr@thyrsus.com>2016-03-15 20:31:21 -0400
commit45d873ea3a6e2122900d2b785b7cd131a7759569 (patch)
treefcf4ec267deb74a759262d38a96aff009671d2af /build.txt
parent1829ba9c5106340b83be4a6dc5d69b37421bc98c (diff)
downloadgpsd-45d873ea3a6e2122900d2b785b7cd131a7759569.tar.gz
Adds support for Python coveraging.
This extends the "coveraging" option to apply coveraging to any Python programs executed during the build. It adds a new option "python_coverage" to allow configuring the command to be used for applying coveraging to Python programs, with a default value of "coverage run" (which is typically appropriate, provided that the coverage package is installed). Setting this to the null string disables Python coveraging. If "python_coverage" has its default value and parallel builds are enabled, "--parallel-mode" is automatically appended to the coverage command. If a non-default coverage command is used, it's the user's responsibility to handle parallelism appropriately. Note that this does not apply coveraging to generated Python code. This also adds the coverage result files to .gitignore, including the C coverage files which weren't there previously. TESTED: Ran "scons check" as well as sample cases of regress-driver -b and -v, both with and without coveraging. Also verified that it works with the full path to the tool supplied as the python_coverage option.
Diffstat (limited to 'build.txt')
-rw-r--r--build.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/build.txt b/build.txt
index 67aa96b7..ef7916b3 100644
--- a/build.txt
+++ b/build.txt
@@ -371,6 +371,18 @@ Because the output from the various jobs is interleaved, it may be more
difficult to understand error results with multiple jobs. In that event,
simply rerun without the -j option for more straightforward output.
+If coveraging is enabled (coveraging=yes), then Python programs run
+during testing are run via Python coveraging. This prefixes the relevant
+commands with the content of the python_coverage option, whose default
+value of "coverage run" is appropriate if the standard Python coverage
+package is installed and accessible in the command path. It can be
+set to a different value if necessary, or set to the empty string to
+disable Python coveraging. The latter happens automatically (with a
+message) if the tool cannot be found. When running multiple jobs with
+"-j", if python_coverage has its default value, "--parallel" is automatically
+appended to the command. With a non-default setting, accomodating
+parallelism is the user's responsibility.
+
For instructions on how to live-test the software, see the file INSTALL.
== Reverting to a clean state ==