timer_stats/doc: Fix /proc/timer_stats documentation
authorMichael Kerrisk <mtk.manpages@gmail.com>
Fri, 2 May 2014 10:13:10 +0000 (12:13 +0200)
committerIngo Molnar <mingo@kernel.org>
Sun, 4 May 2014 18:46:32 +0000 (20:46 +0200)
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.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Link: http://lkml.kernel.org/r/53636FB6.9060407@gmail.com
[ Small tidyup of the changelog. ]
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Documentation/timers/timer_stats.txt

index 8abd40b..de835ee 100644 (file)
@@ -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: