Skip to content

Commit

Permalink
docs: Fix wording in optional zram feature docs
Browse files Browse the repository at this point in the history
This fixes some simple grammar errors in the documentation for zram,
specifically errors in the optional feature section of the zram
documentation.

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
Link: https://lore.kernel.org/r/20220207235442.95090-1-mrtops03@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Ethan Dye authored and Jonathan Corbet committed Feb 15, 2022
1 parent d535e6c commit 4fbe7b1
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions Documentation/admin-guide/blockdev/zram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,8 @@ To use the feature, admin should set up backing device via::

echo /dev/sda5 > /sys/block/zramX/backing_dev

before disksize setting. It supports only partition at this moment.
If admin wants to use incompressible page writeback, they could do via::
before disksize setting. It supports only partitions at this moment.
If admin wants to use incompressible page writeback, they could do it via::

echo huge > /sys/block/zramX/writeback

Expand All @@ -341,9 +341,9 @@ Admin can request writeback of those idle pages at right timing via::

echo idle > /sys/block/zramX/writeback

With the command, zram writeback idle pages from memory to the storage.
With the command, zram will writeback idle pages from memory to the storage.

If admin want to write a specific page in zram device to backing device,
If an admin wants to write a specific page in zram device to the backing device,
they could write a page index into the interface.

echo "page_index=1251" > /sys/block/zramX/writeback
Expand All @@ -354,7 +354,7 @@ to guarantee storage health for entire product life.

To overcome the concern, zram supports "writeback_limit" feature.
The "writeback_limit_enable"'s default value is 0 so that it doesn't limit
any writeback. IOW, if admin wants to apply writeback budget, he should
any writeback. IOW, if admin wants to apply writeback budget, they should
enable writeback_limit_enable via::

$ echo 1 > /sys/block/zramX/writeback_limit_enable
Expand All @@ -365,7 +365,7 @@ until admin sets the budget via /sys/block/zramX/writeback_limit.
(If admin doesn't enable writeback_limit_enable, writeback_limit's value
assigned via /sys/block/zramX/writeback_limit is meaningless.)

If admin want to limit writeback as per-day 400M, he could do it
If admin wants to limit writeback as per-day 400M, they could do it
like below::

$ MB_SHIFT=20
Expand All @@ -375,16 +375,16 @@ like below::
$ echo 1 > /sys/block/zram0/writeback_limit_enable

If admins want to allow further write again once the budget is exhausted,
he could do it like below::
they could do it like below::

$ echo $((400<<MB_SHIFT>>4K_SHIFT)) > \
/sys/block/zram0/writeback_limit

If admin wants to see remaining writeback budget since last set::
If an admin wants to see the remaining writeback budget since last set::

$ cat /sys/block/zramX/writeback_limit

If admin want to disable writeback limit, he could do::
If an admin wants to disable writeback limit, they could do::

$ echo 0 > /sys/block/zramX/writeback_limit_enable

Expand All @@ -393,7 +393,7 @@ system reboot, echo 1 > /sys/block/zramX/reset) so keeping how many of
writeback happened until you reset the zram to allocate extra writeback
budget in next setting is user's job.

If admin wants to measure writeback count in a certain period, he could
If admin wants to measure writeback count in a certain period, they could
know it via /sys/block/zram0/bd_stat's 3rd column.

memory tracking
Expand Down

0 comments on commit 4fbe7b1

Please sign in to comment.