diff mbox series

[net] docs: networking: update XPS to account for netif_set_xps_queue

Message ID 20201013194508.389495-1-willemdebruijn.kernel@gmail.com (mailing list archive)
State Not Applicable
Delegated to: Netdev Maintainers
Headers show
Series [net] docs: networking: update XPS to account for netif_set_xps_queue | expand

Commit Message

Willem de Bruijn Oct. 13, 2020, 7:45 p.m. UTC 
From: Willem de Bruijn <willemb@google.com>

With the introduction of netif_set_xps_queue, XPS can be enabled
by the driver at initialization.

Update the documentation to reflect this, as otherwise users
may incorrectly believe that the feature is off by default.

Fixes: 537c00de1c9b ("net: Add functions netif_reset_xps_queue and netif_set_xps_queue")
Signed-off-by: Willem de Bruijn <willemb@google.com>
---
 Documentation/networking/scaling.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Jakub Kicinski Oct. 13, 2020, 11:28 p.m. UTC | #1 
On Tue, 13 Oct 2020 15:45:08 -0400 Willem de Bruijn wrote:
> From: Willem de Bruijn <willemb@google.com>
> 
> With the introduction of netif_set_xps_queue, XPS can be enabled
> by the driver at initialization.
> 
> Update the documentation to reflect this, as otherwise users
> may incorrectly believe that the feature is off by default.
> 
> Fixes: 537c00de1c9b ("net: Add functions netif_reset_xps_queue and netif_set_xps_queue")
> Signed-off-by: Willem de Bruijn <willemb@google.com>

Applied, thank you!
diff mbox series

Patch

diff --git a/Documentation/networking/scaling.rst b/Documentation/networking/scaling.rst
index 8f0347b9fb3d..3d435caa3ef2 100644
--- a/Documentation/networking/scaling.rst
+++ b/Documentation/networking/scaling.rst
@@ -465,9 +465,9 @@  XPS Configuration
 -----------------
 
 XPS is only available if the kconfig symbol CONFIG_XPS is enabled (on by
-default for SMP). The functionality remains disabled until explicitly
-configured. To enable XPS, the bitmap of CPUs/receive-queues that may
-use a transmit queue is configured using the sysfs file entry:
+default for SMP). If compiled in, it is driver dependent whether, and
+how, XPS is configured at device init. The mapping of CPUs/receive-queues
+to transmit queue can be inspected and configured using sysfs:
 
 For selection based on CPUs map::