diff mbox series

docs: proc.rst: fix wrong time unit

Message ID 20220302161122.3984304-1-uuuuuu@protonmail.com (mailing list archive)
State New, archived
Headers show
Series docs: proc.rst: fix wrong time unit | expand

Commit Message

YI March 2, 2022, 4:11 p.m. UTC
From: YI <afctgo@gmail.com>

Dear Trivial Patch Monkey, 

This commit fixes a small documentaion problem reported in
https://bugzilla.kernel.org/show_bug.cgi?id=194593.

Some fields in the file /proc/$pid/stat represent time.
Their units are clock_t, not jiffies as stated in the documentation.
This commit fixes https://bugzilla.kernel.org/show_bug.cgi?id=194593.

Reported-by: hujunjie
Signed-off-by: YI <afctgo@gmail.com>
---
 Documentation/filesystems/proc.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Jonathan Corbet March 9, 2022, 11:26 p.m. UTC | #1
YI <afctgo@gmail.com> writes:

> From: YI <afctgo@gmail.com>
>
> Dear Trivial Patch Monkey, 

The trivial patch monkey has gone into retirement, I'm as close as
you're going to get.

> This commit fixes a small documentaion problem reported in
> https://bugzilla.kernel.org/show_bug.cgi?id=194593.
>
> Some fields in the file /proc/$pid/stat represent time.
> Their units are clock_t, not jiffies as stated in the documentation.
> This commit fixes https://bugzilla.kernel.org/show_bug.cgi?id=194593.

We certainly don't need to give the bugzilla URL twice; I'm not
convinced it's needed even once.  The changelog should just say what the
patch does, please.

Also, "clock_t" isn't really a unit type; what are the actual units of
the field?

> Reported-by: hujunjie

This isn't a valid reported-by line

> Signed-off-by: YI <afctgo@gmail.com>

...and the signoff need to have your full name, please.

Thanks,

jon
diff mbox series

Patch

diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 061744c436d9..433ad4623630 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -340,10 +340,10 @@  It's slow but very precise.
   cmin_flt      number of minor faults with child's
   maj_flt       number of major faults
   cmaj_flt      number of major faults with child's
-  utime         user mode jiffies
-  stime         kernel mode jiffies
-  cutime        user mode jiffies with child's
-  cstime        kernel mode jiffies with child's
+  utime         user mode processor time (clock_t)
+  stime         kernel mode processor time (clock_t)
+  cutime        user mode processor time (clock_t) with child's
+  cstime        kernel mode processor time (clock_t) with child's
   priority      priority level
   nice          nice level
   num_threads   number of threads
@@ -370,8 +370,8 @@  It's slow but very precise.
   rt_priority   realtime priority
   policy        scheduling policy (man sched_setscheduler)
   blkio_ticks   time spent waiting for block IO
-  gtime         guest time of the task in jiffies
-  cgtime        guest time of the task children in jiffies
+  gtime         guest time of the task in processor time (clock_t)
+  cgtime        guest time of the task children in processor time (clock_t)
   start_data    address above which program data+bss is placed
   end_data      address below which program data+bss is placed
   start_brk     address above which program heap can be expanded with brk()