doc: fix a typo in ntb guide
Checks
Commit Message
In prerequisites of ntb guide, the correct flag when loading igb_uio
module should be `wc_activate=1`, not `wc_active=1`.
Fixes: 11b5c7daf019 ("raw/ntb: add enqueue and dequeue functions")
Cc: stable@dpdk.org
Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
---
doc/guides/rawdevs/ntb.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
Comments
> -----Original Message-----
> From: Li, Xiaoyun <xiaoyun.li@intel.com>
> Sent: Wednesday, December 4, 2019 11:20 PM
> To: Wu, Jingjing <jingjing.wu@intel.com>
> Cc: dev@dpdk.org; Li, Xiaoyun <xiaoyun.li@intel.com>; stable@dpdk.org
> Subject: [PATCH] doc: fix a typo in ntb guide
>
> In prerequisites of ntb guide, the correct flag when loading igb_uio
> module should be `wc_activate=1`, not `wc_active=1`.
>
> Fixes: 11b5c7daf019 ("raw/ntb: add enqueue and dequeue functions")
> Cc: stable@dpdk.org
>
> Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
Acked-by: Jingjing Wu <jingjing.wu@intel.com>
> ---
> doc/guides/rawdevs/ntb.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/guides/rawdevs/ntb.rst b/doc/guides/rawdevs/ntb.rst
> index 58472135f..aa7d80964 100644
> --- a/doc/guides/rawdevs/ntb.rst
> +++ b/doc/guides/rawdevs/ntb.rst
> @@ -52,11 +52,11 @@ NTB PMD needs kernel PCI driver to support write combining (WC) to
> get
> better performance. The difference will be more than 10 times.
> To enable WC, there are 2 ways.
>
> -- Insert igb_uio with ``wc_active=1`` flag if use igb_uio driver.
> +- Insert igb_uio with ``wc_activate=1`` flag if use igb_uio driver.
>
> .. code-block:: console
>
> - insmod igb_uio.ko wc_active=1
> + insmod igb_uio.ko wc_activate=1
>
> - Enable WC for NTB device's Bar 2 and Bar 4 (Mapped memory) manually.
> The reference is https://www.kernel.org/doc/html/latest/x86/mtrr.html
> --
> 2.17.1
23/12/2019 03:39, Wu, Jingjing:
> From: Li, Xiaoyun <xiaoyun.li@intel.com>
> > In prerequisites of ntb guide, the correct flag when loading igb_uio
> > module should be `wc_activate=1`, not `wc_active=1`.
> >
> > Fixes: 11b5c7daf019 ("raw/ntb: add enqueue and dequeue functions")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
> Acked-by: Jingjing Wu <jingjing.wu@intel.com>
Applied, thanks
@@ -52,11 +52,11 @@ NTB PMD needs kernel PCI driver to support write combining (WC) to get
better performance. The difference will be more than 10 times.
To enable WC, there are 2 ways.
-- Insert igb_uio with ``wc_active=1`` flag if use igb_uio driver.
+- Insert igb_uio with ``wc_activate=1`` flag if use igb_uio driver.
.. code-block:: console
- insmod igb_uio.ko wc_active=1
+ insmod igb_uio.ko wc_activate=1
- Enable WC for NTB device's Bar 2 and Bar 4 (Mapped memory) manually.
The reference is https://www.kernel.org/doc/html/latest/x86/mtrr.html