From nobody Sat Apr 20 14:21:56 2024 Delivered-To: importer2@patchew.org Received-SPF: pass (zohomail.com: domain of vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; envelope-from=linux-kernel-owner@vger.kernel.org; helo=vger.kernel.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail(p=none dis=none) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mx.zohomail.com with SMTP id 1644282810684794.4633516645757; Mon, 7 Feb 2022 17:13:30 -0800 (PST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1343594AbiBHBGD (ORCPT ); Mon, 7 Feb 2022 20:06:03 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47410 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1343745AbiBGXyq (ORCPT ); Mon, 7 Feb 2022 18:54:46 -0500 Received: from mail-io1-xd34.google.com (mail-io1-xd34.google.com [IPv6:2607:f8b0:4864:20::d34]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1D12BC061355; Mon, 7 Feb 2022 15:54:46 -0800 (PST) Received: by mail-io1-xd34.google.com with SMTP id r144so19067042iod.9; Mon, 07 Feb 2022 15:54:46 -0800 (PST) Received: from localhost.localdomain (c-174-52-171-58.hsd1.ut.comcast.net. [174.52.171.58]) by smtp.gmail.com with ESMTPSA id w10sm6948815iow.44.2022.02.07.15.54.44 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Mon, 07 Feb 2022 15:54:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=IsFG5/GvZCP7d6Q7fgcMRKXpI72aUAEHst1zGwkjpaw=; b=Ttmc6V889RmJ6MHAGUJtazmXijIa85n3LlNxupw3lelmko7Xng3pDOFVybhEpsG35n 8eEmXbgeqYzvp7n83Y8J2m/Zcklhm/ey9Cpj+PHrOUD6qhvBjd3E4Wq/OogBqZk2k8Aa txj0Wd9LNQanpICfBvecoBB7NpS5RSDwWr7G972OZVZynLwy06wLHYb6NJOjgS0tNb6h 3+1Y8aFO0Hd/UrTC1tJGVe0toX542zxMEVLMNdX2eCXPcCzHMxbUOJleTAqGQJgORAPN Z60YJFTYrk8Xo+ZZNaXiZ4ar5YajGVyxg1bbgIx2KfHG6vEzEgMdoUcoO/zx8AVMsezj +U9w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=IsFG5/GvZCP7d6Q7fgcMRKXpI72aUAEHst1zGwkjpaw=; b=mDVfs3FvxE4ZKLXsoQBCDwBh0PbRivo1yW+vr0HAE6EGF+jdeJ5uzUehyy+atIJM+D KUmJPGsyql3Fz4wFqM7RVxNnzlq9U5sAGeG++IP7JwH90E1MQtW8kQLNkSV8wucvkY64 YAeLWaovwzsXqWykPqp8/efE0uIXCPJe/6DIxQwBnIk9hcEkJXusK8/HU0V4CxadBvfm fMzkkCLjIFMsRKYzpAAYVqFvJ5kbxiJo1rylNiLYgP7wMmCpzZ1+r97ip77/yETw+mUo 3uZUAOledXIL+KRBgzNmlvmBOrVuKf6+CHBiNobQ8T99XKFlQVBh0crBCJzkSp1Vya9H 24RA== X-Gm-Message-State: AOAM530VpBLwtqLUACO3Ryf7DXQ5RXT/aRaB1yP7/+9yEii6ytgOKSRa glaAWR3Vvn0NMlM0HMGCSvCAu+D7R4t0p6uw X-Google-Smtp-Source: ABdhPJxXRaSZjvMa7wV2I843eAN5giCRrPzED7V6mf7qaX885XlsWgHillQURNcqTg9lrfh8ROfE9w== X-Received: by 2002:a05:6638:10ea:: with SMTP id g10mr959591jae.79.1644278085342; Mon, 07 Feb 2022 15:54:45 -0800 (PST) From: Ethan Dye Cc: Ethan Dye , Minchan Kim , Nitin Gupta , Sergey Senozhatsky , Philipp Reisner , Lars Ellenberg , Jonathan Corbet , linux-kernel@vger.kernel.org, drbd-dev@lists.linbit.com, linux-doc@vger.kernel.org Subject: [PATCH] block/zram: Fix wording in optional feature docs Date: Mon, 7 Feb 2022 16:54:42 -0700 Message-Id: <20220207235442.95090-1-mrtops03@gmail.com> X-Mailer: git-send-email 2.32.0 (Apple Git-132) MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_ENVFROM_END_DIGIT, FREEMAIL_FROM,RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net To: unlisted-recipients:; (no To-header on input) Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1644282812535100039 Content-Type: text/plain; charset="utf-8" This fixes some simple grammar errors in the documentation for zram, specifically errors in the optional featue section of the zram documentation. Signed-off-by: Ethan Dye --- Documentation/admin-guide/blockdev/zram.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/admin-guide/blockdev/zram.rst b/Documentation/ad= min-guide/blockdev/zram.rst index 3e11926a4df9..54fe63745ed8 100644 --- a/Documentation/admin-guide/blockdev/zram.rst +++ b/Documentation/admin-guide/blockdev/zram.rst @@ -315,8 +315,8 @@ To use the feature, admin should set up backing device = via:: =20 echo /dev/sda5 > /sys/block/zramX/backing_dev =20 -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:: =20 echo huge > /sys/block/zramX/writeback =20 @@ -341,9 +341,9 @@ Admin can request writeback of those idle pages at righ= t timing via:: =20 echo idle > /sys/block/zramX/writeback =20 -With the command, zram writeback idle pages from memory to the storage. +With the command, zram will writeback idle pages from memory to the storag= e. =20 -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 d= evice, they could write a page index into the interface. =20 echo "page_index=3D1251" > /sys/block/zramX/writeback @@ -354,7 +354,7 @@ to guarantee storage health for entire product life. =20 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:: =20 $ echo 1 > /sys/block/zramX/writeback_limit_enable @@ -365,7 +365,7 @@ until admin sets the budget via /sys/block/zramX/writeb= ack_limit. (If admin doesn't enable writeback_limit_enable, writeback_limit's value assigned via /sys/block/zramX/writeback_limit is meaningless.) =20 -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:: =20 $ MB_SHIFT=3D20 @@ -375,16 +375,16 @@ like below:: $ echo 1 > /sys/block/zram0/writeback_limit_enable =20 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:: =20 $ echo $((400<>4K_SHIFT)) > \ /sys/block/zram0/writeback_limit =20 -If admin wants to see remaining writeback budget since last set:: +If an admin wants to see the remaining writeback budget since last set:: =20 $ cat /sys/block/zramX/writeback_limit =20 -If admin want to disable writeback limit, he could do:: +If an admin wants to disable writeback limit, they could do:: =20 $ echo 0 > /sys/block/zramX/writeback_limit_enable =20 @@ -393,7 +393,7 @@ system reboot, echo 1 > /sys/block/zramX/reset) so keep= ing how many of writeback happened until you reset the zram to allocate extra writeback budget in next setting is user's job. =20 -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. =20 memory tracking --=20 2.32.0 (Apple Git-132)