On Thu, Mar 28, 2024 at 03:25:56PM +0100, Ilya Maximets wrote: > On 3/22/24 16:56, Simon Horman wrote: > > The Kernel datapath is no longer present in the primary development > > branch of the OVS tree. Update documentation to more clearly reflect > > this. > > > > Documentation relating to the kernel datapath in the OVS tree can > > be removed once 2.17 is EOL. > > > > Also, update wording of affected text as there is more than one upstream > > networking maintainer these days. > > > > Signed-off-by: Simon Horman <ho...@ovn.org> > > --- > > Changes in v2: > > - Rather than removing documentation update it to make it clearer > > that the datapath is not present since version 3.0. > > - Link to v1: > > https://lore.kernel.org/r/20240321-dei-kernel-dp-doc-v1-1-f8cd82869...@ovn.org > > --- > > * Addresses review of > > - [PATCH] Documentation: Remove references to kernel datapath in OVS tree. > > https://mail.openvswitch.org/pipermail/ovs-dev/2024-March/412685.html > > --- > > Documentation/faq/releases.rst | 18 > > +++++++++++++++--- > > .../internals/contributing/backporting-patches.rst | 13 ++++++++----- > > 2 files changed, 23 insertions(+), 8 deletions(-) > > Thanks, Simon! > > I think, the documentation can still use some re-wording around referencing > the kernel module in the OVS tree, but this change is a good start. So,
Yes, I agree there is scope for more work here. > Acked-by: Ilya Maximets <i.maxim...@ovn.org> > > Some small nits below. Thanks, applied with the nits addressed. - Documentation: Update references to kernel datapath in OVS tree. https://github.com/openvswitch/ovs/commit/2324596f1151 > > diff --git a/Documentation/faq/releases.rst b/Documentation/faq/releases.rst > > index 49b987b610c3..7d97d73de2df 100644 > > --- a/Documentation/faq/releases.rst > > +++ b/Documentation/faq/releases.rst > > @@ -110,7 +110,7 @@ Q: Are all features available with all datapaths? > > Linux OVS tree > > The datapath implemented by the Linux kernel module distributed with > > the OVS source tree. This datapath is deprecated starting with OVS > > - 2.15.x and support capped at Linux kernel version 5.8. As of OVS > > 3.0.x > > + 2.15 and support capped at Linux kernel version 5.8. As of OVS 3.0 > > the Linux OVS tree is no longer supported. > > This document is using double spaces between sentences most of the time. > This paragraph didn't, but since we're touching it, we may as well fix that, > I suppose. Thanks, done. > > Userspace > > @@ -256,8 +256,11 @@ Q: I get an error like this when I configure Open > > vSwitch: > > that one, because it may support the kernel that you are building > > against. (To find out, consult the table in the previous FAQ.) > > > > - - The Open vSwitch "master" branch may support the kernel that you are > > - using, so consider building the kernel module from "master". > > + - For Open vSwitch releases prior to 3.0, the corresponding Open > > + vSwitch branch may support the kernel that you are using, so consider > > + building the kernel module from that branch. For Open vSwitch 2.17, > > + the only non EOL release to which this applies, the branch is > > + "branch-2.17". > > And use double spaces in the newly added text. Also done. > > All versions of Open vSwitch userspace are compatible with all > > versions of > > the Open vSwitch kernel module, so you do not have to use the kernel > > module > > @@ -277,6 +280,9 @@ ships as part of the upstream Linux kernel? > > supported, consider upgrading to a newer upstream Linux release or > > using > > the kernel module paired with the userspace distribution. > > > > + Please note that as of Open vSwitch 3.0 the kernel module is no longer > > + part of the Open vSwitch distribution. > > + > > Q: Why do tunnels not work when using a kernel module other than the one > > packaged with Open vSwitch? > > > > @@ -303,6 +309,9 @@ packaged with Open vSwitch? > > doing this, check to make sure that the module that is loaded is the > > one > > you expect. > > > > + Please note that as of Open vSwitch 3.0 the kernel module is no longer > > + part of the Open vSwitch distribution. > > + > > Q: Why are UDP tunnel checksums not computed for VXLAN or Geneve? > > > > A: Generating outer UDP checksums requires kernel support that was not > > part > > @@ -311,6 +320,9 @@ Q: Why are UDP tunnel checksums not computed for VXLAN > > or Geneve? > > out-of-tree modules from Open vSwitch release 2.4 and later support UDP > > checksums. > > > > + Please note that as of Open vSwitch 3.0 the kernel module is no longer > > + part of the Open vSwitch distribution. > > + > > Q: What features are not available when using the userspace datapath? > > > > A: Tunnel virtual ports are not supported, as described in the previous > > diff --git a/Documentation/internals/contributing/backporting-patches.rst > > b/Documentation/internals/contributing/backporting-patches.rst > > index 0ef7f5beb9b0..04bb0fc350fd 100644 > > --- a/Documentation/internals/contributing/backporting-patches.rst > > +++ b/Documentation/internals/contributing/backporting-patches.rst > > @@ -52,11 +52,14 @@ branches. > > For Linux datapath code, the primary development branch is in the > > `net-next`_ > > tree as described in the section below, and patch discussion occurs on the > > `netdev`__ mailing list. Patches are first applied to the upstream branch > > by the > > -networking maintainer, then the contributor backports the patch to the Open > > -vSwitch `master` development branch. Patches in this category may include > > -features which have been applied upstream, or bugfixes to the Open vSwitch > > -datapath code. For bugfixes, the patches subsequently follow the regular > > Open > > -vSwitch process as described above to reach older branches. > > +networking maintainers, then the contributor backports the patch to an Open > > +vSwitch branch. Patches in this category may include features which have > > +been applied upstream, or bugfixes to the Open vSwitch datapath code. > > + > > +The practice for Linux datapath code described above is currently only > > +applicable to bugfixes for Open vSwitch 2.17. This is because all earlier > > +versions are EOL and all subsequent versions do not include the Linux > > +datapath as it is now maintained as part of the upstream Linux kernel. > > > > __ https://lore.kernel.org/netdev/ > > > > > > FWIW, this whole document doesn't have double spacing, so the change also > shouldn't. Thanks, left this part as-is. _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
