[ovs-dev] [PATCH v2] FAQ: Add entry about different datapaths features.

[Daniele Di Proietto]

On 10/12/2015 17:35, "Joe Stringer" <joe at ovn.org> wrote:

>On 10 December 2015 at 16:15, Daniele Di Proietto
><diproiettod at vmware.com> wrote:
>> This is an easy way to keep track of the features supported by the
>> different datapaths.
>>
>> Nithin helped filling the list for the Hyper-V port.
>>
>> CC: Nithin Raju <nithin at vmware.com>
>> Signed-off-by: Daniele Di Proietto <diproiettod at vmware.com>
>> Acked-by: Ben Pfaff <blp at ovn.org>
>> Acked-by: Nithin Raju <nithin at vmware.com>
>> ---
>> v1 -> v2:
>>
>> * Mention FreeBSD and NetBSD in the userspace datapath description.
>> * Split QoS in shaping and policing.
>> * Remove previous FAQ (superseeded by this).
>> ---
>>  FAQ.md | 88 
>>+++++++++++++++++++++++++++++++++++++++++++++++++-----------------
>>  1 file changed, 66 insertions(+), 22 deletions(-)
>>
>> diff --git a/FAQ.md b/FAQ.md
>> index 8397e0f..9a87002 100644
>> --- a/FAQ.md
>> +++ b/FAQ.md
>> @@ -165,28 +165,72 @@ A: The following table lists the Linux kernel
>>versions against which the
>>     It should build against almost any kernel, certainly against 2.6.32
>>     and later.
>>
>> -### Q: Are all features available with all versions of the kernel
>>module?
>> -
>> -A: Features are gradually introduced into the upstream kernel so unless
>> -   you are running the latest Linux release there may be some missing
>> -   features. ovs-vswitchd probes for kernel features during startup and
>> -   lists them in the ovs-vswitchd log file. If you need features that
>> -   are unsupported, you can upgrade the Linux version or use the kernel
>> -   module paired with the userspace distribution.
>> -
>> -   For a given Open vSwitch release, the vast majority of features are
>> -   supported when using the kernel module paired with the userspace
>> -   distribution, no matter which kernel you build it against. However,
>> -   from time to time, new features may be introduced which rely on
>> -   functionality not available in older kernels. The features below are
>> -   included in the kernel module distributed with OVS, but have more
>> -   stringent requirements for minimum kernel versions than the support
>> -   listed earlier.
>> -
>> -| Feature   | Open vSwitch | Linux kernel
>> -|:---------:|:------------:|:------------:
>> -|    STT    |     2.4+     |     3.5+
>> -| Conntrack |     2.5+     |     3.10+
>> +### Q: Are all features available with all datapaths?
>> +
>> +A: Open vSwitch supports different datapaths on different platforms.
>>Each
>> +   datapath has a different feature set: the following tables try to
>>summarize
>> +   the status.
>> +
>> +   Supported datapaths:
>> +
>> +   * *Linux upstream*: The datapath implemented by the kernel module
>>shipped
>> +                       with Linux upstream.  Since features have been
>>gradually
>> +                       introduced into the kernel, the table mentions
>>the first
>> +                       Linux release whose OVS module supports the
>>feature.
>> +
>> +   * *Linux OVS tree*: The datapath implemented by the Linux kernel
>>module
>> +                       distributed with the OVS source tree. Some
>>features of
>> +                       this module rely on functionality not available
>>in older
>> +                       kernels: in this case the minumum Linux version
>>(against
>> +                       which the module can be compiled) is listed.
>
>Thanks! Minor nit, perhaps it should say "(against which the feature
>can be compiled)".
>
>LGTM.

I applied your suggestion, thanks!