Thanks for writing documentation! On Fri, May 20, 2016 at 11:49:54AM -0700, Joe Stringer wrote: > --- a/INSTALL.md > +++ b/INSTALL.md > @@ -101,6 +101,14 @@ To run the unit tests, you also need: > - Perl. Version 5.10.1 is known to work. Earlier versions should > also work. > > +The "system" tests for userspace and Linux datapaths also rely upon:
By "system" tests here, do you mean what is called the "datapath traffic" tests later on? If so, then it would be nice to use the same name in both places. (Looking at Andy's comments, I see I'm duplicating this one. Great minds think alike I guess.) > +Datapath traffic testing > +------------------------ > + > +Open vSwitch also includes a suite of tests specifically for datapath > +functionality, which can be run against the userspace or kernel datapaths. > +If you are developing datapath features, it is recommended that you use > +these tests and build upon them to verify your implementation. > > -Requires: Vagrant (version 1.7.0 or later) and a compatible hypervisor > +The datapath tests make some assumptions about the environment. They > +must be run under root privileges on a Linux system with support for > +network namespaces. These tests are recommended to be run within an > +isolated environment that is separate from your development system. A couple of uses of passive voice above. I guess it's clear that the author of the documentation is the one doing the recommending though. However, I think that a change to active voice in the next sentence would enhance clarity; otherwise it isn't clear where the vagrant box is. How about: "For ease of use, the OVS source tree includes a vagrant box to invoke these tests." > +For ease of use, a vagrant box is provided to invoke these tests. This > +also provides kernel isolation, protecting your development host from > +kernel panics or configuration conflicts in the testsuite. If you wish > +to run the tests without using the vagrant box, there are further > +instructions below. Thanks again! Acked-by: Ben Pfaff <b...@ovn.org> _______________________________________________ dev mailing list dev@openvswitch.org http://openvswitch.org/mailman/listinfo/dev
