Skip to contentSkip to conversation

timer_stats, doc: Readout of /proc/timer_stats doesn't disable sampling

PATCH New Michael Kerrisk (man-pages) 2 participants 2 messages May 2, 2014 – May 5, 2014

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 timer_stats, doc: Readout of /proc/timer_stats doesn't disable sampling

From: Michael Kerrisk <[email protected]>

Some simple testing shows that reading from /proc/timer_stats does not disable sampling. Looking back over past source code, it appears that it never did.

---
 Documentation/timers/timer_stats.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/timers/timer_stats.txt +3 -3
index 8abd40b..de835ee 100644
@@ -39,9 +39,9 @@ To stop a sample period issue:
 The statistics can be retrieved by:
 # cat /proc/timer_stats
 
-The readout of /proc/timer_stats automatically disables sampling. The sampled
-information is kept until a new sample period is started. This allows multiple
-readouts.
+While sampling is enabled, each readout from /proc/timer_stats will see
+newly updated statistics. Once sampling is disabled, the sampled information
+is kept until a new sample period is started. This allows multiple readouts.
 
 Sample output of /proc/timer_stats:
 
Signature · 1 line
1.9.0
#1 lore raw

[tip:timers/core] timer_stats/doc: Fix /proc/ timer_stats documentation

timer_stats/doc: Fix /proc/timer_stats documentation
Commit-ID:  2779ac167b1a1bf8153dca9f3a141c6148c6b89f
Gitweb:     http://git.kernel.org/tip/2779ac167b1a1bf8153dca9f3a141c6148c6b89f
Author:     Michael Kerrisk <[email protected]>
AuthorDate: Fri, 2 May 2014 12:13:10 +0200
Committer:  Ingo Molnar <[email protected]>
CommitDate: Sun, 4 May 2014 20:46:32 +0200

timer_stats/doc: Fix /proc/timer_stats documentation

Documentation/timers/timer_stats.txt claims:

"The readout of /proc/timer_stats automatically disables sampling. The sampled
information is kept until a new sample period is started. This allows multiple readouts."

Some simple testing shows that reading from /proc/timer_stats does not disable sampling. Looking back over past source code, it appears that it never did.

---
 Documentation/timers/timer_stats.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/timers/timer_stats.txt +3 -3
index 8abd40b..de835ee 100644
@@ -39,9 +39,9 @@ To stop a sample period issue:
 The statistics can be retrieved by:
 # cat /proc/timer_stats
 
-The readout of /proc/timer_stats automatically disables sampling. The sampled
-information is kept until a new sample period is started. This allows multiple
-readouts.
+While sampling is enabled, each readout from /proc/timer_stats will see
+newly updated statistics. Once sampling is disabled, the sampled information
+is kept until a new sample period is started. This allows multiple readouts.
 
 Sample output of /proc/timer_stats: