Skip to contentSkip to conversation

docs: networking: update XPS to account for netif_set_xps_queue

PATCH Applied Willem de Bruijn 2 participants 2 messages Oct 13, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: networking: update XPS to account for netif_set_xps_queue

From: Willem de Bruijn <[email protected]>

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")
---
 Documentation/networking/scaling.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/networking/scaling.rst +3 -3
index 8f0347b9fb3d..3d435caa3ef2 100644
@@ -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::
 
Signature · 1 line
2.28.0.1011.ga647a8990f-goog
maintainer Applied
#1 lore raw
Quoted 10 lines · On Tue, 13 Oct 2020 15:45:08 -0400 Willem de Bruijn wrote:

From: Willem de Bruijn <[email protected]>

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")

Applied, thank you!