[PATCH v6 1/2] doc: fix ice scheduler rate-limiter burst size description

[Dawid Wesierski]

The paragraph describing the rl_burst_size devarg did not mention
that out-of-range values are rejected, which can otherwise look like
a silent no-op to a reader. Add a note that such values cause the
driver to fail to initialize, since ice_cfg_rl_burst_size() validates
the value and dev_probe() bails out with -EINVAL if it is rejected.

Fixes: b3f2afb3b7ea ("net/ice: add scheduler rate-limiter burst size devarg")

Signed-off-by: Dawid Wesierski <dawid.wesierski at intel.com>
---
 doc/guides/nics/ice.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 5589ce934f..2f7c9e6f7c 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -164,6 +164,7 @@ Runtime Configuration
   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.
   A value of ``0`` (the default) keeps the hardware default.
+  Values outside the range supported by the hardware cause the driver to fail to initialize.
 
   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.