top: minimal necessary corrections to the man document

After experimenting with those 4.5 kernel enhancements
to /proc/<pid>/status, that newly added overview topic
'Memory Types' was found to be in need of some tweaks.

In addition, the 'DATA' description wasn't quite broad
enough since explicit private file mappings impact it.

( lastly, for the record, the 2nd commit referred to )
( below contained an incorrect reference that should )
( have been the original issue 21 commit. instead it )
( showed an invalid SHA-1 hash. i believe i have now )
( identified a flaw in my workflow that produced it. )

Reference(s):
. original patch responding to issue #21
commit e4bbd3ca1abe57bc52e7eff72aa3973ecf67765c
. subsequent patch with invalid commit ref
commit 5dcbcd00fe0978b5e2e8e0a19a34389d896e84d9

Signed-off-by: Jim Warner <james.warner@comcast.net>

diff --git a/top/top.1 b/top/top.1
index 1529aceabf6148da3d6264fac14a7b088e26901d..ab9dfbc46b45c1bde3c8b7f698471848da897e0a 100644 (file)
--- a/top/top.1
+++ b/top/top.1
@@ -69,7 +69,7 @@
 .
 .\" Document /////////////////////////////////////////////////////////////
 .\" ----------------------------------------------------------------------
-.TH TOP 1 "October 2015" "procps-ng" "User Commands"
+.TH TOP 1 "April 2016" "procps-ng" "User Commands"
 .\" ----------------------------------------------------------------------
 
 .\" ----------------------------------------------------------------------
@@ -307,7 +307,7 @@ The memory in quadrant #4, when modified, acts as its own dedicated \*(MS.
                           \fB1\fR           |          \fB2\fR
      \fBAnonymous\fR  . stack               |
                 . malloc()            |
-                . brk()/sbrk()        |
+                . brk()/sbrk()        | . POSIX shm*
                 . mmap(PRIVATE, ANON) | . mmap(SHARED, ANON)
                -----------------------+----------------------
                 . mmap(PRIVATE, fd)   | . mmap(SHARED, fd)
@@ -317,13 +317,15 @@ The memory in quadrant #4, when modified, acts as its own dedicated \*(MS.
 
 The following may help in interpreting process level memory values displayed
 as columns and discussed in topic `3a. DESCRIPTIONS of Fields'.
+
 .nf
    %MEM \- simply RES divided by total \*(MP
    CODE \- the `pgms' portion of quadrant \fB3\fR
-   DATA \- the quadrant \fB1\fR portion of VIRT
+   DATA \- the entire quadrant \fB1\fR portion of VIRT plus all
+          explicit mmap file-backed pages of quadrant \fB3\fR
    RES  \- anything occupying \*(MP (all quadrants)
    SHR  \- subset of RES (excludes \fB1\fR, includes all \fB2\fR & \fB4\fR, some \fB3\fR)
-   SWAP \- excludes quadrant \fB4\fR
+   SWAP \- potentially any quadrant except \fB4\fR
    USED \- simply the sum of RES and SWAP
    VIRT \- everything in-use and/or reserved (all quadrants)
 .fi
@@ -677,7 +679,7 @@ any truncated data.
 
 .TP 4
  6.\fB DATA \*(Em Data + Stack Size (KiB) \fR
-The amount of private anonymous memory \fIreserved\fR by a process.
+The amount of private memory \fIreserved\fR by a process.
 It is also known as the Data Resident Set or DRS.
 Such memory may not yet be mapped to \*(MP (RES) but will always be
 included in the \*(MV (VIRT) amount.