Skip to contentSkip to conversation

docs: admin-guide: fix printk_ratelimit explanation

PATCH In review Oleksandr Natalenko 2 participants 3 messages Oct 2, 2019 – Oct 10, 2019 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: admin-guide: fix printk_ratelimit explanation

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.

---
 Documentation/admin-guide/sysctl/kernel.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
Documentation/admin-guide/sysctl/kernel.rst +4 -2
index 032c7cd3cede..6e0da29e55f1 100644
@@ -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:
 ===============
Signature · 1 line
2.23.0
#1 lore raw

Hi.

Quoted 42 lines · 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.

---
 Documentation/admin-guide/sysctl/kernel.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
Documentation/admin-guide/sysctl/kernel.rst +4 -2
index 032c7cd3cede..6e0da29e55f1 100644
@@ -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:
 ===============
Signature · 1 line
2.23.0

This is a gentle ping. Please review.

Thanks.

Signature · 3 lines
  Best regards,
    Oleksandr Natalenko (post-factum)
    Senior Software Maintenance Engineer
maintainer
#2 lore raw
In reply to Oleksandr Natalenko
Quoted 11 lines · On Wed, 2 Oct 2019 13:46:10 +0200 Oleksandr Natalenko <[email protected]>…

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.

This seems good. Applied, thanks.

jon