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

[Bruce Richardson]

On Mon, Jul 13, 2026 at 05:42:57AM -0400, Dawid Wesierski wrote:
> 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.

Acked-by: Bruce Richardson <bruce.richardson at intel.com>

Applied to dpdk-next-net-intel.
Thanks,
/Bruce