[PATCH] docs: admin-guide: fix printk_ratelimit explanation

[PATCH] docs: admin-guide: fix printk_ratelimit explanation

[Oleksandr Natalenko]

The printk_ratelimit value accepts seconds, not jiffies (though it is
converted into jiffies internally). Update documentation to reflect
this.

Also, remove the statement about allowing 1 message in 5 seconds since
bursts up to 10 messages are allowed by default.

Finally, while we are here, mention default value for
printk_ratelimit_burst too.

Signed-off-by: Oleksandr Natalenko <oleksandr@redhat.com>
---
 Documentation/admin-guide/sysctl/kernel.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index 032c7cd3cede..6e0da29e55f1 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -831,8 +831,8 @@ printk_ratelimit:
 =================
 
 Some warning messages are rate limited. printk_ratelimit specifies
-the minimum length of time between these messages (in jiffies), by
-default we allow one every 5 seconds.
+the minimum length of time between these messages (in seconds).
+The default value is 5 seconds.
 
 A value of 0 will disable rate limiting.
 
@@ -845,6 +845,8 @@ 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.
 
+The default value is 10 messages.
+
 
 printk_devkmsg:
 ===============
-- 
2.23.0

Re: [PATCH] docs: admin-guide: fix printk_ratelimit explanation

[Oleksandr Natalenko]

Hi.

On Wed, Oct 02, 2019 at 01:46:10PM +0200, Oleksandr Natalenko wrote:
> The printk_ratelimit value accepts seconds, not jiffies (though it is
> converted into jiffies internally). Update documentation to reflect
> this.
> 
> Also, remove the statement about allowing 1 message in 5 seconds since
> bursts up to 10 messages are allowed by default.
> 
> Finally, while we are here, mention default value for
> printk_ratelimit_burst too.
> 
> Signed-off-by: Oleksandr Natalenko <oleksandr@redhat.com>
> ---
>  Documentation/admin-guide/sysctl/kernel.rst | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index 032c7cd3cede..6e0da29e55f1 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -831,8 +831,8 @@ printk_ratelimit:
>  =================
>  
>  Some warning messages are rate limited. printk_ratelimit specifies
> -the minimum length of time between these messages (in jiffies), by
> -default we allow one every 5 seconds.
> +the minimum length of time between these messages (in seconds).
> +The default value is 5 seconds.
>  
>  A value of 0 will disable rate limiting.
>  
> @@ -845,6 +845,8 @@ 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.
>  
> +The default value is 10 messages.
> +
>  
>  printk_devkmsg:
>  ===============
> -- 
> 2.23.0
> 

This is a gentle ping. Please review.

Thanks.

-- 
  Best regards,
    Oleksandr Natalenko (post-factum)
    Senior Software Maintenance Engineer

Re: [PATCH] docs: admin-guide: fix printk_ratelimit explanation

[Jonathan Corbet]

On Wed,  2 Oct 2019 13:46:10 +0200
Oleksandr Natalenko <oleksandr@redhat.com> wrote:

> The printk_ratelimit value accepts seconds, not jiffies (though it is
> converted into jiffies internally). Update documentation to reflect
> this.
> 
> Also, remove the statement about allowing 1 message in 5 seconds since
> bursts up to 10 messages are allowed by default.
> 
> Finally, while we are here, mention default value for
> printk_ratelimit_burst too.
> 
> Signed-off-by: Oleksandr Natalenko <oleksandr@redhat.com>

This seems good.  Applied, thanks.

jon