Remove documentation relating to OOT kernel module.
Support for the OOT module was removed in the v3.0 release of Open vSwitch.
And is now no longer supported by any maintained versions of Open vSwitch.
Signed-off-by: Simon Horman <ho...@ovn.org>
---
Changes in v2
* Refer to kernel version rather than kernel module version.
(Suggested by Eelco)
---
Documentation/intro/install/general.rst | 55 +++++----------------------------
1 file changed, 8 insertions(+), 47 deletions(-)
diff --git a/Documentation/intro/install/general.rst
b/Documentation/intro/install/general.rst
index 0f3cb4e4961d..8d46c2a7526e 100644
--- a/Documentation/intro/install/general.rst
+++ b/Documentation/intro/install/general.rst
@@ -101,39 +101,9 @@ need the following software:
environment variable OVS_UNBOUND_CONF can be used to specify the
configuration file for unbound.
-On Linux, you may choose to compile the kernel module that comes with the Open
-vSwitch distribution or to use the kernel module built into the Linux kernel
-(version 3.3 or later). See the :doc:`/faq/index` question "What features are
-not available in the Open vSwitch kernel datapath that ships as part of the
-upstream Linux kernel?" for more information on this trade-off. You may also
-use the userspace-only implementation, at some cost in features and
-performance. Refer to :doc:`userspace` for details.
-
-To compile the kernel module on Linux, you must also install the
-following:
-
-- A supported Linux kernel version.
-
- For optional support of ingress policing, you must enable kernel
- configuration options ``NET_CLS_BASIC``, ``NET_SCH_INGRESS``, and
- ``NET_ACT_POLICE``, either built-in or as modules. ``NET_CLS_POLICE`` is
- obsolete and not needed.)
-
- On kernels before 3.11, the ``ip_gre`` module, for GRE tunnels over IP
- (``NET_IPGRE``), must not be loaded or compiled in.
-
- To configure HTB or HFSC quality of service with Open vSwitch, you must
- enable the respective configuration options.
-
- To use Open vSwitch support for TAP devices, you must enable ``CONFIG_TUN``.
-
-- To build a kernel module, you need the same version of GCC that was used to
- build that kernel.
-
-- A kernel build directory corresponding to the Linux kernel image the module
- is to run on. Under Debian and Ubuntu, for example, each linux-image package
- containing a kernel binary has a corresponding linux-headers package with
- the required build infrastructure.
+On Linux, you may use the kernel module distributed with the upstream Linux
+kernel 3.3 or later. You may also use the userspace-only implementation, at
+some cost in features and performance. Refer to :doc:`userspace` for details.
If you are working from a Git tree or snapshot (instead of from a distribution
tarball), or if you modify the Open vSwitch build system or the database
@@ -192,11 +162,10 @@ simply install and run Open vSwitch you require the
following software:
- Shared libraries compatible with those used for the build.
- On Linux, if you want to use the kernel-based datapath (which is the most
- common use case), then a kernel with a compatible kernel module. This
- can be a kernel module built with Open vSwitch (e.g. in the previous
- step), or the kernel module that accompanies Linux 3.3 and later. Open
- vSwitch features and performance can vary based on the module and the
- kernel. Refer to :doc:`/faq/releases` for more information.
+ common use case), then a kernel with a compatible kernel module. The kernel
+ module is distributed with the upstream Linux kernel 3.3 and later. Open
+ vSwitch features and performance can vary based on the kernel version.
+ Refer to :doc:`/faq/releases` for more information.
- For optional support of ingress policing on Linux, the "tc" program
from iproute2 (part of all major distributions and available at
@@ -286,13 +255,6 @@ With this, GCC will detect the processor and automatically
set appropriate
flags for it. This should not be used if you are compiling OVS outside the
target machine.
-.. note::
- CFLAGS are not applied when building the Linux kernel module. Custom CFLAGS
- for the kernel module are supplied using the ``EXTRA_CFLAGS`` variable when
- running make. For example::
-
- $ make EXTRA_CFLAGS="-Wno-error=date-time"
-
If you are a developer and want to enable Address Sanitizer for debugging
purposes, at about a 2x runtime cost, you can add
``-fsanitize=address -fno-omit-frame-pointer -fno-common`` to CFLAGS. For
@@ -326,8 +288,7 @@ option::
You can also run configure from a separate build directory. This is helpful if
you want to build Open vSwitch in more than one way from a single source
-directory, e.g. to try out both GCC and Clang builds, or to build kernel
-modules for more than one Linux version. For example::
+directory, e.g. to try out both GCC and Clang builds. For example::
$ mkdir _gcc && (cd _gcc && ./configure CC=gcc)
$ mkdir _clang && (cd _clang && ./configure CC=clang)
--
2.47.2
_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
