Skip to contentSkip to conversation

doc: fix a typo in ntb guide

PATCH Applied Xiaoyun Li 3 participants 3 messages Dec 4, 2019 – Jan 20, 2020

lore
Share & tools
lore

Xiaoyun Li

author
#0 lore raw

PATCH 1/1 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")
---
 doc/guides/rawdevs/ntb.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/rawdevs/ntb.rst +2 -2
index 58472135f..aa7d80964 100644
@@ -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
Signature · 1 line
2.17.1
Acked-by on v1 1/1
#1 lore raw
Quoted 9 lines

-----Original Message-----
From: Li, Xiaoyun <[email protected]>
Sent: Wednesday, December 4, 2019 11:20 PM
To: Wu, Jingjing <[email protected]>
Cc: [email protected]; Li, Xiaoyun <[email protected]>; [email protected]
Subject: [PATCH] doc: fix a typo in ntb guide

Quoted 7 lines

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")
Quoted 25 lines
---
 doc/guides/rawdevs/ntb.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/rawdevs/ntb.rst +0 -0
index 58472135f..aa7d80964 100644
@@ -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

doc/guides/rawdevs/ntb.rst +1 -2
-  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