CONTRIBUTING.md: Strengthen testing recommendataions.
authorMark Kavanagh <mark.b.kavanagh@intel.com>
Tue, 10 Feb 2015 14:46:22 +0000 (14:46 +0000)
committerBen Pfaff <blp@nicira.com>
Sun, 15 Feb 2015 16:38:38 +0000 (08:38 -0800)
Patches that modify existing code can break expected behaviour.
Flag this by testing the patch with 'make check' prior to submission.

Furthermore, it is not sufficient to only test patches that add files
using 'make distcheck'; the compile flags for this target could change
the definition of some functions (ovs_assert, for example), altering
the outcome of some unit tests. Rather, it is preferable to use a
combination of 'make distcheck' with 'make check' to cover all bases.

Signed-off-by: Mark Kavanagh <mark.b.kavanagh@intel.com>
Signed-off-by: Ben Pfaff <blp@nicira.com>
CONTRIBUTING.md

index 23c5410..d48924f 100644 (file)
@@ -27,7 +27,10 @@ In particular:
 
 Testing is also important:
 
-  - A patch that adds or deletes files should be tested with
+  - A patch that modifies existing code should be tested with
+    `make check` before submission.
+
+  - A patch that adds or deletes files should also be tested with
     `make distcheck` before submission.
 
   - A patch that modifies Linux kernel code should be at least