mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	Cezary Rojewski <cezary.rojewski@intel.com>,
	Oded Gabbay <oded.gabbay@gmail.com>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	Tom Rix <trix@redhat.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 11/17] ABI: sysfs-class-bdi: use What: to describe each property
Date: Mon, 27 Sep 2021 15:59:44 +0200	[thread overview]
Message-ID: <77e5904dfd275ed2670cd13779e5ef1da96e355c.1632750608.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1632750608.git.mchehab+huawei@kernel.org>

Instead of listing all bdi entries inside the description, add
one entry for each, just like the remaining ABI files.

That allows get_abi.pl script to properly parse it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

See [PATCH 00/17] at: https://lore.kernel.org/all/cover.1632750608.git.mchehab+huawei@kernel.org/

 Documentation/ABI/testing/sysfs-class-bdi | 30 ++++++++++++++++-------
 1 file changed, 21 insertions(+), 9 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-class-bdi b/Documentation/ABI/testing/sysfs-class-bdi
index 5402bd74ba43..6d2a2fc189dd 100644
--- a/Documentation/ABI/testing/sysfs-class-bdi
+++ b/Documentation/ABI/testing/sysfs-class-bdi
@@ -23,14 +23,17 @@ default
 	The default backing dev, used for non-block device backed
 	filesystems which do not provide their own BDI.
 
-Files under /sys/class/bdi/<bdi>/
-
-read_ahead_kb (read-write)
-
+What:		/sys/class/bdi/<bdi>/read_ahead_kb
+Date:		January 2008
+Contact:	Peter Zijlstra <a.p.zijlstra@chello.nl>
+Description:
 	Size of the read-ahead window in kilobytes
 
-min_ratio (read-write)
-
+	(read-write)
+What:		/sys/class/bdi/<bdi>/min_ratio
+Date:		January 2008
+Contact:	Peter Zijlstra <a.p.zijlstra@chello.nl>
+Description:
 	Under normal circumstances each device is given a part of the
 	total write-back cache that relates to its current average
 	writeout speed in relation to the other devices.
@@ -39,8 +42,12 @@ min_ratio (read-write)
 	percentage of the write-back cache to a particular device.
 	For example, this is useful for providing a minimum QoS.
 
-max_ratio (read-write)
+	(read-write)
 
+What:		/sys/class/bdi/<bdi>/max_ratio
+Date:		January 2008
+Contact:	Peter Zijlstra <a.p.zijlstra@chello.nl>
+Description:
 	Allows limiting a particular device to use not more than the
 	given percentage of the write-back cache.  This is useful in
 	situations where we want to avoid one device taking all or
@@ -48,7 +55,12 @@ max_ratio (read-write)
 	mount that is prone to get stuck, or a FUSE mount which cannot
 	be trusted to play fair.
 
-stable_pages_required (read-only)
-
+	(read-write)
+What:		/sys/class/bdi/<bdi>/stable_pages_required
+Date:		January 2008
+Contact:	Peter Zijlstra <a.p.zijlstra@chello.nl>
+Description:
 	If set, the backing device requires that all pages comprising a write
 	request must not be changed until writeout is complete.
+
+	(read-only)
-- 
2.31.1


  parent reply	other threads:[~2021-09-27 14:00 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-27 13:59 [PATCH 00/17] ABI: update files to reduce the documentation gap Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 01/17] ABI: stable/sysfs-module: better document modules Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 02/17] ABI: stable/sysfs-module: document version and srcversion Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 03/17] ABI: testing/sysfs-module: document initstate Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 04/17] ABI: sysfs-devices-power: document some RPM statistics Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 05/17] ABI: sysfs-devices: add /dev ABI Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 06/17] ABI: sysfs-bus-pci: add documentation for modalias Mauro Carvalho Chehab
2021-09-28 10:48   ` Greg Kroah-Hartman
2021-09-28 11:48     ` Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 07/17] ABI: o2cb: add an obsolete file for /sys/o2cb Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 08/17] ABI: sysfs-kernel-slab: Document some stats Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 09/17] ABI: sysfs-devices-power: add some debug sysfs files Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 10/17] ABI: sysfs-bus-pci: add a alternative What fields Mauro Carvalho Chehab
2021-09-28 18:34   ` Bjorn Helgaas
2021-09-28 22:07     ` Mauro Carvalho Chehab
2021-09-27 13:59 ` Mauro Carvalho Chehab [this message]
2021-09-27 13:59 ` [PATCH 12/17] ABI: sysfs-bus-mdio: add alternate What for mdio symbols Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 13/17] ABI: sysfs-bus-usb: use a wildcard for interface name on What Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 14/17] ABI: sysfs-bus-usb: add missing sysfs fields Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 15/17] ABI: obsolete/sysfs-bus-iio: add some missing blank lines Mauro Carvalho Chehab
2021-09-27 13:59 ` [PATCH 16/17] ABI: sysfs-driver-ufs: Add another What for platform drivers Mauro Carvalho Chehab
2021-09-29  6:32   ` Avri Altman
2021-09-29  7:03     ` Greg Kroah-Hartman
2021-09-29  7:23       ` Avri Altman
2021-09-29  7:39         ` Greg Kroah-Hartman
2021-09-27 13:59 ` [PATCH 17/17] ABI: sysfs-bus-platform: add modalias description Mauro Carvalho Chehab
2021-09-27 21:00   ` Barry Song

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=77e5904dfd275ed2670cd13779e5ef1da96e355c.1632750608.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=cezary.rojewski@intel.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=oded.gabbay@gmail.com \
    --cc=suzuki.poulose@arm.com \
    --cc=trix@redhat.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®