[PATCH] makedumpfile.8: "cache without private" column of the table for -d appears to be incorrect

[Atsushi Kumagai]

Hello,

>Hi,
>
>The makedumpfile man page contains a table explaining the usage of -d.
>The "cache without private" column implies that -d 4 would exclude "cache
>without private" pages. However, a -d 4 should only exclude "cache with
>private".

"cache with private" includes "cache without private" because the latter
doesn't mean leaving private cache pages, just mean excluding cache pages
except private pages. Meanwhile, "cache with private" means excluding both
cache pages (private and non-private). So "with private" meets "without private"
in this feature, they aren't exclusive.
This style is for diskdump compatibility, but now I suspect it may be
bit confusing.

I don't want to change the behavior of the page filtering, but I guess
changing the column names might be meaningful.
I'm curious to know what everyone thought of the two columns. This can
be a good opportunity to make the manual easier to understand.


Thanks,
Atsushi Kumagai

>makedumpfile.h:
>------------------------------------------------------------
> #define DL_EXCLUDE_CACHE        (0x002) /* Exclude Cache Pages
>                                            without Private Pages */
>------------------------------------------------------------
>
>makedumpfile.8:
>------------------------------------------------------------
>                     |      |cache  |cache  |      |
>                dump | zero |without|with   | user | free
>               level | page |private|private| data | page
>              -------+------+-------+-------+------+------
>                   0 |      |       |       |      |
>                   1 |  X   |       |       |      |
>                   2 |      |   X   |       |      |
>                   3 |  X   |   X   |       |      |
>                   4 |      |   X   |   X   |      |
>                   5 |  X   |   X   |   X   |      |
>                   6 |      |   X   |   X   |      |
>                   7 |  X   |   X   |   X   |      |
>                   8 |      |       |       |  X   |
>------------------------------------------------------------
>
>Signed-off-by: Harshula Jayasuriya <harshula at redhat.com>
>---
> makedumpfile.8 | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)
>
>diff --git a/makedumpfile.8 b/makedumpfile.8
>index 9cb12c0..382c6ee 100644
>--- a/makedumpfile.8
>+++ b/makedumpfile.8
>@@ -174,32 +174,32 @@ by dump_level 11, makedumpfile retries it by dump_level 31.
>      1 |  X   |       |       |      |
>      2 |      |   X   |       |      |
>      3 |  X   |   X   |       |      |
>-     4 |      |   X   |   X   |      |
>-     5 |  X   |   X   |   X   |      |
>+     4 |      |       |   X   |      |
>+     5 |  X   |       |   X   |      |
>      6 |      |   X   |   X   |      |
>      7 |  X   |   X   |   X   |      |
>      8 |      |       |       |  X   |
>      9 |  X   |       |       |  X   |
>     10 |      |   X   |       |  X   |
>     11 |  X   |   X   |       |  X   |
>-    12 |      |   X   |   X   |  X   |
>-    13 |  X   |   X   |   X   |  X   |
>+    12 |      |       |   X   |  X   |
>+    13 |  X   |       |   X   |  X   |
>     14 |      |   X   |   X   |  X   |
>     15 |  X   |   X   |   X   |  X   |
>     16 |      |       |       |      |  X
>     17 |  X   |       |       |      |  X
>     18 |      |   X   |       |      |  X
>     19 |  X   |   X   |       |      |  X
>-    20 |      |   X   |   X   |      |  X
>-    21 |  X   |   X   |   X   |      |  X
>+    20 |      |       |   X   |      |  X
>+    21 |  X   |       |   X   |      |  X
>     22 |      |   X   |   X   |      |  X
>     23 |  X   |   X   |   X   |      |  X
>     24 |      |       |       |  X   |  X
>     25 |  X   |       |       |  X   |  X
>     26 |      |   X   |       |  X   |  X
>     27 |  X   |   X   |       |  X   |  X
>-    28 |      |   X   |   X   |  X   |  X
>-    29 |  X   |   X   |   X   |  X   |  X
>+    28 |      |       |   X   |  X   |  X
>+    29 |  X   |       |   X   |  X   |  X
>     30 |      |   X   |   X   |  X   |  X
>     31 |  X   |   X   |   X   |  X   |  X
>
>--
>1.9.3