[PATCH] Documentation: /proc/loadavg: add 3 more field descriptions

[PATCH] Documentation: /proc/loadavg: add 3 more field descriptions

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Update contents of /proc/loadavg: add 3 more fields.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-doc@vger.kernel.org
---
 Documentation/filesystems/proc.rst |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

--- linux-next-20210202.orig/Documentation/filesystems/proc.rst
+++ linux-next-20210202/Documentation/filesystems/proc.rst
@@ -687,7 +687,10 @@ files are there, and which are missing.
  kcore        Kernel core image (can be ELF or A.OUT(deprecated in 2.4))
  kmsg         Kernel messages
  ksyms        Kernel symbol table
- loadavg      Load average of last 1, 5 & 15 minutes
+ loadavg      Load average of last 1, 5 & 15 minutes;
+                number of processes currently runnable (running or on ready queue);
+                total number of processes in system;
+                last pid created.
  locks        Kernel locks
  meminfo      Memory info
  misc         Miscellaneous

Re: [PATCH] Documentation: /proc/loadavg: add 3 more field descriptions

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> From: Randy Dunlap <rdunlap@infradead.org>
>
> Update contents of /proc/loadavg: add 3 more fields.

...except that two of those fields are actually a single field with a
slash in the middle.

> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: linux-doc@vger.kernel.org
> ---
>  Documentation/filesystems/proc.rst |    5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> --- linux-next-20210202.orig/Documentation/filesystems/proc.rst
> +++ linux-next-20210202/Documentation/filesystems/proc.rst
> @@ -687,7 +687,10 @@ files are there, and which are missing.
>   kcore        Kernel core image (can be ELF or A.OUT(deprecated in 2.4))
>   kmsg         Kernel messages
>   ksyms        Kernel symbol table
> - loadavg      Load average of last 1, 5 & 15 minutes
> + loadavg      Load average of last 1, 5 & 15 minutes;
> +                number of processes currently runnable (running or on ready queue);
> +                total number of processes in system;

Given that those two fields (for reasons certainly unknown to me) are
different than the rest, it seems like we should actually explain how
they are formatted.

> +                last pid created.
>   locks        Kernel locks
>   meminfo      Memory info
>   misc         Miscellaneous

The patch is an improvement over what's there now, so I've applied it,
but it seems like a further tweak might be called for.

Thanks,

jon