[ovs-dev] [PATCH 1/6] INSTALL.md: Document system-traffic tests.

[Joe Stringer]

On 2 June 2016 at 15:01, Ben Pfaff <blp at ovn.org> wrote:
>> +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 <blp at ovn.org>

Thanks for the suggestions. I took another pass at the wording,
applied the feedback, and pushed to master.