[PATCH] docs: kernel: Clarify printk_ratelimit_burst reset behavior

[PATCH] docs: kernel: Clarify printk_ratelimit_burst reset behavior

[Breno Leitao]

Add clarification that the printk_ratelimit_burst window resets after
printk_ratelimit seconds have elapsed, allowing another burst of
messages to be sent. This helps users understand that the rate limiting
is not permanent but operates in periodic windows.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 Documentation/admin-guide/sysctl/kernel.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index a43b78b4b6464..6f8d3935147da 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -1099,7 +1099,8 @@ printk_ratelimit_burst
 While long term we enforce one message per `printk_ratelimit`_
 seconds, we do allow a burst of messages to pass through.
 ``printk_ratelimit_burst`` specifies the number of messages we can
-send before ratelimiting kicks in.
+send before ratelimiting kicks in.  After `printk_ratelimit`_ seconds
+have elapsed, another burst of messages may be sent.
 
 The default value is 10 messages.
 

---
base-commit: 0907e7fb35756464aa34c35d6abb02998418164b
change-id: 20250714-docs_ratelimit-8f4a30f29908

Best regards,
--  
Breno Leitao <leitao@debian.org>

Re: [PATCH] docs: kernel: Clarify printk_ratelimit_burst reset behavior

[Paul E. McKenney]

On Mon, Jul 14, 2025 at 05:06:27AM -0700, Breno Leitao wrote:
> Add clarification that the printk_ratelimit_burst window resets after
> printk_ratelimit seconds have elapsed, allowing another burst of
> messages to be sent. This helps users understand that the rate limiting
> is not permanent but operates in periodic windows.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Reviewed-by: Paul E. McKenney <paulmck@kernel.org>

> ---
>  Documentation/admin-guide/sysctl/kernel.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index a43b78b4b6464..6f8d3935147da 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -1099,7 +1099,8 @@ printk_ratelimit_burst
>  While long term we enforce one message per `printk_ratelimit`_
>  seconds, we do allow a burst of messages to pass through.
>  ``printk_ratelimit_burst`` specifies the number of messages we can
> -send before ratelimiting kicks in.
> +send before ratelimiting kicks in.  After `printk_ratelimit`_ seconds
> +have elapsed, another burst of messages may be sent.
>  
>  The default value is 10 messages.
>  
> 
> ---
> base-commit: 0907e7fb35756464aa34c35d6abb02998418164b
> change-id: 20250714-docs_ratelimit-8f4a30f29908
> 
> Best regards,
> --  
> Breno Leitao <leitao@debian.org>
> 

Re: [PATCH] docs: kernel: Clarify printk_ratelimit_burst reset behavior

[Jonathan Corbet]

Breno Leitao <leitao@debian.org> writes:

> Add clarification that the printk_ratelimit_burst window resets after
> printk_ratelimit seconds have elapsed, allowing another burst of
> messages to be sent. This helps users understand that the rate limiting
> is not permanent but operates in periodic windows.
>
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>  Documentation/admin-guide/sysctl/kernel.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index a43b78b4b6464..6f8d3935147da 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -1099,7 +1099,8 @@ printk_ratelimit_burst
>  While long term we enforce one message per `printk_ratelimit`_
>  seconds, we do allow a burst of messages to pass through.
>  ``printk_ratelimit_burst`` specifies the number of messages we can
> -send before ratelimiting kicks in.
> +send before ratelimiting kicks in.  After `printk_ratelimit`_ seconds
> +have elapsed, another burst of messages may be sent.
>  

Applied, thanks.

jon