LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Minchan Kim <minchan@kernel.org>
To: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>
Cc: Andrew Morton <akpm@linux-foundation.org>,
	Nitin Gupta <ngupta@vflare.org>,
	linux-kernel@vger.kernel.org,
	Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>
Subject: Re: [PATCH 4/6] zram: describe device attrs in documentation
Date: Thu, 12 Mar 2015 10:33:19 +0900	[thread overview]
Message-ID: <20150312013319.GD10820@blaptop> (raw)
In-Reply-To: <1426000114-4471-5-git-send-email-sergey.senozhatsky@gmail.com>

On Wed, Mar 11, 2015 at 12:08:32AM +0900, Sergey Senozhatsky wrote:
> Briefly describe exported device stat attrs in zram documentation.
> We will eventually get rid of per-stat sysfs nodes and, thus,
> clean up Documentation/ABI/testing/sysfs-block-zram file, which is
> the only source of information about device sysfs nodes.
> 
> Add `num_migrated' description, since there is no independent
> `num_migrated' sysfs node (and no corresponding sysfs-block-zram
> entry), it will be exported via zram<id>/mm_stat file.
> 
> At this point we can provide minimal attrs description, because
> sysfs-block-zram still contains detailed information.
> 
> Signed-off-by: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>

FYI, git-am got failed based on next-2015311 but patch tool worked.

> ---
>  Documentation/blockdev/zram.txt | 49 +++++++++++++++++++++++++++++------------
>  1 file changed, 35 insertions(+), 14 deletions(-)
> 
> diff --git a/Documentation/blockdev/zram.txt b/Documentation/blockdev/zram.txt
> index 902c97c..149b49a 100644
> --- a/Documentation/blockdev/zram.txt
> +++ b/Documentation/blockdev/zram.txt
> @@ -117,20 +117,41 @@ execute
>  	echo X > /sys/class/zram-control/zram_remove
>  
>  8) Stats:
> -	Per-device statistics are exported as various nodes under
> -	/sys/block/zram<id>/
> -		disksize
> -		num_reads
> -		num_writes
> -		failed_reads
> -		failed_writes
> -		invalid_io
> -		notify_free
> -		zero_pages
> -		orig_data_size
> -		compr_data_size
> -		mem_used_total
> -		mem_used_max
> +Per-device statistics are exported as various nodes under /sys/block/zram<id>/
> +
> +A brief description of exported device attritbutes. For more details please
> +read Documentation/ABI/testing/sysfs-block-zram.
> +
> +Name             mode             description
> +----            ------            -----------
> +disksize          RO    disk size

disksize is RW

> +initstate         RO    shows the initialization state of the device
> +reset             WO    trigger device reset
> +num_reads         RO    the number of reads
> +failed_reads      RO    the number of failed reads
> +num_write         RO    the number of writes
> +failed_writes     RO    the number of failed writes
> +invalid_io        RO    the number of non-page-size-aligned I/O requests
> +max_comp_streams  RW    the number of possible concurrent compress operations
> +comp_algorithm    RW    show and change the compression algorithm
> +notify_free       RO    the number of notifications to free pages (either
> +                        slot free notifications or REQ_DISCARD requests)
> +zero_pages        RO    the number of zero filled pages written to this disk
> +orig_data_size    RO    uncompressed size of data stored in this disk
> +compr_data_size   RO    compressed size of data stored in this disk
> +mem_used_total    RO    the amount of memory allocated for this disk
> +mem_used_max      RW    the maximum amount of memory zram have consumed to
> +                        store compressed data
> +mem_limit         RW    the maximum amount of memory ZRAM can use to store
> +                        the compressed data
> +num_migrated      RO    the number of objects migrated by compaction
> +compact           WO    trigger memory compaction

Otherwise, looks cleaner!
Thanks!
 

-- 
Kind regards,
Minchan Kim

  reply	other threads:[~2015-03-12  1:33 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-10 15:08 [PATCH 0/6] new zram statistics reporting scheme Sergey Senozhatsky
2015-03-10 15:08 ` [PATCH 1/6] zram: remove `num_migrated' device attr Sergey Senozhatsky
2015-03-12  1:16   ` Minchan Kim
2015-03-12  1:22     ` Sergey Senozhatsky
2015-03-10 15:08 ` [PATCH 2/6] zram: move compact_store() to sysfs functions area Sergey Senozhatsky
2015-03-12  1:24   ` Minchan Kim
2015-03-10 15:08 ` [PATCH 3/6] zram: use generic start/end io accounting Sergey Senozhatsky
2015-03-12  1:25   ` Minchan Kim
2015-03-10 15:08 ` [PATCH 4/6] zram: describe device attrs in documentation Sergey Senozhatsky
2015-03-12  1:33   ` Minchan Kim [this message]
2015-03-12  1:47     ` Sergey Senozhatsky
2015-03-10 15:08 ` [PATCH 5/6] zram: export new 'io_stat' sysfs attrs Sergey Senozhatsky
2015-03-12  1:36   ` Minchan Kim
2015-03-10 15:08 ` [PATCH 6/6] zram: export new 'mm_stat' " Sergey Senozhatsky
2015-03-12  1:41   ` Minchan Kim
2015-03-12  1:54     ` Sergey Senozhatsky
2015-03-12  1:55 ` [PATCH 0/6] new zram statistics reporting scheme Minchan Kim
2015-03-12  2:16   ` Sergey Senozhatsky
2015-03-12  5:03     ` Sergey Senozhatsky
2015-03-12  5:11     ` Minchan Kim
2015-03-12  5:24       ` Sergey Senozhatsky

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150312013319.GD10820@blaptop \
    --to=minchan@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ngupta@vflare.org \
    --cc=sergey.senozhatsky.work@gmail.com \
    --cc=sergey.senozhatsky@gmail.com \
    --subject='Re: [PATCH 4/6] zram: describe device attrs in documentation' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).