doc: update uio module status in Linux guide
diff mbox series

Message ID 20200521151107.3730552-1-ferruh.yigit@intel.com
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: update uio module status in Linux guide
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Ferruh Yigit May 21, 2020, 3:11 p.m. UTC
igb_uio kernel module disabled by default starting from v20.02, document
this to prevent confusion.

And add note about long term igb_uio plans/directions to move it to
another repo based on DPDK technical board decision:
http://mails.dpdk.org/archives/dev/2019-November/151763.html

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/guides/linux_gsg/linux_drivers.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Thomas Monjalon May 24, 2020, 9:16 p.m. UTC | #1
21/05/2020 17:11, Ferruh Yigit:
> igb_uio kernel module disabled by default starting from v20.02, document
> this to prevent confusion.
> 
> And add note about long term igb_uio plans/directions to move it to
> another repo based on DPDK technical board decision:
> http://mails.dpdk.org/archives/dev/2019-November/151763.html
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> --- a/doc/guides/linux_gsg/linux_drivers.rst
> +++ b/doc/guides/linux_gsg/linux_drivers.rst
> +.. note::
> +
> +   ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``. To build
> +   it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be enabled.
> +   And in long term it is planned to move ``igb_uio`` module to different git repo.

Removed "long term", as it is planned for 20.11.
Applied with above change, thanks

Patch
diff mbox series

diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 238f3e9002..27a55e02a9 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -36,6 +36,12 @@  be loaded as shown below:
     sudo modprobe uio
     sudo insmod kmod/igb_uio.ko
 
+.. note::
+
+   ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``. To build
+   it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be enabled.
+   And in long term it is planned to move ``igb_uio`` module to different git repo.
+
 .. note::
 
     For some devices which lack support for legacy interrupts, e.g. virtual function