Subject: [PATCH] Correct description of SwapFree in Documentation/filesystems/proc.txt

After migrating most of the information in
Documentation/filesystems/proc.txt to the proc(5) man page,
Jim Paris pointed out to me that the description of SwapFree
in the man page seemed wrong. I think Jim is right,
but am given pause by fact that that text has been in
Documentation/filesystems/proc.txt since at least 2.6.0.
Anyway, I believe that the patch below fixes things.

Signed-off-by: Michael Kerrisk <[email protected]>


diff --git a/Documentation/filesystems/proc.txt b/Documentation/filesystems/proc.txt
index a1793d6..cf4260f 100644
--- a/Documentation/filesystems/proc.txt
+++ b/Documentation/filesystems/proc.txt
@@ -778,8 +778,7 @@ AnonHugePages: 49152 kB
other things, it is where everything from the Slab is
allocated. Bad things happen when you're out of lowmem.
SwapTotal: total amount of swap space available
- SwapFree: Memory which has been evicted from RAM, and is temporarily
- on the disk
+ SwapFree: Amount of swap space that is currently unused.
Dirty: Memory which is waiting to get written back to the disk
Writeback: Memory which is actively being written back to the disk
AnonPages: Non-file backed pages mapped into userspace page tables


2012-11-16 10:10:14

by Michal Hocko

[permalink] [raw]
Subject: Re: [PATCH] Correct description of SwapFree in Documentation/filesystems/proc.txt

On Fri 16-11-12 08:01:42, Michael Kerrisk wrote:
> After migrating most of the information in
> Documentation/filesystems/proc.txt to the proc(5) man page,
> Jim Paris pointed out to me that the description of SwapFree
> in the man page seemed wrong. I think Jim is right,
> but am given pause by fact that that text has been in
> Documentation/filesystems/proc.txt since at least 2.6.0.
> Anyway, I believe that the patch below fixes things.

Yes, this goes back to 2003 when the /proc/meminfo doc has been added.

>
> Signed-off-by: Michael Kerrisk <[email protected]>

Reviewed-by: Michal Hocko <[email protected]>

> diff --git a/Documentation/filesystems/proc.txt b/Documentation/filesystems/proc.txt
> index a1793d6..cf4260f 100644
> --- a/Documentation/filesystems/proc.txt
> +++ b/Documentation/filesystems/proc.txt
> @@ -778,8 +778,7 @@ AnonHugePages: 49152 kB
> other things, it is where everything from the Slab is
> allocated. Bad things happen when you're out of lowmem.
> SwapTotal: total amount of swap space available
> - SwapFree: Memory which has been evicted from RAM, and is temporarily
> - on the disk
> + SwapFree: Amount of swap space that is currently unused.
> Dirty: Memory which is waiting to get written back to the disk
> Writeback: Memory which is actively being written back to the disk
> AnonPages: Non-file backed pages mapped into userspace page tables
>
> --
> To unsubscribe, send a message with 'unsubscribe linux-mm' in
> the body to [email protected]. For more info on Linux MM,
> see: http://www.linux-mm.org/ .
> Don't email: <a href=mailto:"[email protected]"> [email protected] </a>

--
Michal Hocko
SUSE Labs

2012-11-16 10:16:55

by Kamezawa Hiroyuki

[permalink] [raw]
Subject: Re: [PATCH] Correct description of SwapFree in Documentation/filesystems/proc.txt

(2012/11/16 16:01), Michael Kerrisk wrote:
> After migrating most of the information in
> Documentation/filesystems/proc.txt to the proc(5) man page,
> Jim Paris pointed out to me that the description of SwapFree
> in the man page seemed wrong. I think Jim is right,
> but am given pause by fact that that text has been in
> Documentation/filesystems/proc.txt since at least 2.6.0.
> Anyway, I believe that the patch below fixes things.
>
> Signed-off-by: Michael Kerrisk <[email protected]>
>

Acked-by: KAMEZAWA Hiroyuki <[email protected]>

>
> diff --git a/Documentation/filesystems/proc.txt b/Documentation/filesystems/proc.txt
> index a1793d6..cf4260f 100644
> --- a/Documentation/filesystems/proc.txt
> +++ b/Documentation/filesystems/proc.txt
> @@ -778,8 +778,7 @@ AnonHugePages: 49152 kB
> other things, it is where everything from the Slab is
> allocated. Bad things happen when you're out of lowmem.
> SwapTotal: total amount of swap space available
> - SwapFree: Memory which has been evicted from RAM, and is temporarily
> - on the disk
> + SwapFree: Amount of swap space that is currently unused.
> Dirty: Memory which is waiting to get written back to the disk
> Writeback: Memory which is actively being written back to the disk
> AnonPages: Non-file backed pages mapped into userspace page tables
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to [email protected]
> More majordomo info at http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at http://www.tux.org/lkml/
>

2012-11-17 23:15:19

by Rob Landley

[permalink] [raw]
Subject: Re: [PATCH] Correct description of SwapFree in Documentation/filesystems/proc.txt

On 11/16/2012 01:01:42 AM, Michael Kerrisk wrote:
> After migrating most of the information in
> Documentation/filesystems/proc.txt to the proc(5) man page,
> Jim Paris pointed out to me that the description of SwapFree
> in the man page seemed wrong. I think Jim is right,
> but am given pause by fact that that text has been in
> Documentation/filesystems/proc.txt since at least 2.6.0.
> Anyway, I believe that the patch below fixes things.
>
> Signed-off-by: Michael Kerrisk <[email protected]>

Acked-by: Rob Landley <[email protected]>

Want me to forward it on? (Lots of documentation stuff gets grabbed by
whoever maintains what it's documenting, this looks like it might fall
through the cracks...)

Rob

Subject: Re: [PATCH] Correct description of SwapFree in Documentation/filesystems/proc.txt

Rob,

On Sat, Nov 17, 2012 at 6:11 AM, Rob Landley <[email protected]> wrote:
> On 11/16/2012 01:01:42 AM, Michael Kerrisk wrote:
>>
>> After migrating most of the information in
>> Documentation/filesystems/proc.txt to the proc(5) man page,
>> Jim Paris pointed out to me that the description of SwapFree
>> in the man page seemed wrong. I think Jim is right,
>> but am given pause by fact that that text has been in
>> Documentation/filesystems/proc.txt since at least 2.6.0.
>> Anyway, I believe that the patch below fixes things.
>>
>> Signed-off-by: Michael Kerrisk <[email protected]>
>
>
> Acked-by: Rob Landley <[email protected]>
>
> Want me to forward it on? (Lots of documentation stuff gets grabbed by
> whoever maintains what it's documenting, this looks like it might fall
> through the cracks...)

That would be great.

Thanks,

Michael


--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface"; http://man7.org/tlpi/