The paragraph describing the ``rl_burst_size`` devarg was mangled
(a mid-sentence line break split "favours throughput" across two
lines with no space), and it did not mention that out-of-range
values are rejected by the driver, which can otherwise look like a
silent no-op to a reader.
Fixes: b3f2afb3b7ea ("net/ice: add scheduler rate-limiter burst size devarg")
Signed-off-by: Dawid Wesierski <[email protected]>
---
doc/guides/nics/ice.rst | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 5589ce934f..6c2063d47e 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -160,9 +160,10 @@ Runtime Configuration
- ``Scheduler rate-limiter burst size`` (default ``0``)
- The hardware Tx scheduler uses a default rate-limiter burst size that
favours throughput.
- Time-sensitive applications can lower this value to reduce Tx latency jitter
- at the cost of throughput by setting the ``rl_burst_size`` devargs
parameter, in bytes.
+ The hardware Tx scheduler uses a default rate-limiter burst size that favours
+ throughput. Time-sensitive applications can lower this value to reduce Tx
+ latency jitter at the cost of throughput by setting the ``rl_burst_size``
+ devargs parameter, in bytes. Values that are out of range are rejected.
A value of ``0`` (the default) keeps the hardware default.
For example::
--
2.47.3
---------------------------------------------------------------------
Intel Technology Poland sp. z o.o.
ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydzial
Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-316 |
Kapital zakladowy 200.000 PLN.
Spolka oswiadcza, ze posiada status duzego przedsiebiorcy w rozumieniu ustawy z
dnia 8 marca 2013 r. o przeciwdzialaniu nadmiernym opoznieniom w transakcjach
handlowych.
Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata i
moze zawierac informacje poufne. W razie przypadkowego otrzymania tej
wiadomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie;
jakiekolwiek przegladanie lub rozpowszechnianie jest zabronione.
This e-mail and any attachments may contain confidential material for the sole
use of the intended recipient(s). If you are not the intended recipient, please
contact the sender and delete all copies; any review or distribution by others
is strictly prohibited.
