From a6c2af564633bc3b44ae89b6a0a8aa9d719b43a7 Mon Sep 17 00:00:00 2001 From: Paul Moore Date: Tue, 28 Feb 2017 15:16:33 -0500 Subject: doc: add a note about writing new tests in SUBMITTING_PATCHES Signed-off-by: Paul Moore --- SUBMITTING_PATCHES.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/SUBMITTING_PATCHES.md b/SUBMITTING_PATCHES.md index 61170ea..c24e141 100644 --- a/SUBMITTING_PATCHES.md +++ b/SUBMITTING_PATCHES.md @@ -38,6 +38,18 @@ command: ... if there are any faults or errors they will be displayed. +## Make Sure Your Code is Tested + +The libseccomp code includes a fairly extensive test suite and any submissions +which add functionality or significantly change the existing code should +include additional tests to verify the proper operation of the proposed +changes. + +Code coverage analysis tools has been integrated into the libseccomp code base, +and can be enabled via the "--enable-code-coverage" configure flag and the +"check-code-coverage" make target. Additional details on generating code +coverage information can be found in the .travis.yml file. + ## Generate the Patch(es) Depending on how you decided to work with the libseccomp code base and what -- cgit v1.2.1