From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: ARC-Seal: i=1; a=rsa-sha256; t=1516698638; cv=none; d=google.com; s=arc-20160816; b=LeMSyGIZJXsUP+au7wx/Sf3ttgayofpWuINygI28gCbX6Dd9f8XSxd7aI9GJ3bLIFN 0sITSr4rzKMb6AJi5cAZ8NUwsOSu04CVCBAghpgqXpn4UiiR0N6lJA7X+hCT1aoaM1kB IBahUyryw65LbVJAbGwZkY48qSmu55sNxT9xnLGhGae7d3vbe9xsh/0wS8ewLdwoWlGG gdNnFQ2Yf6TRVyKPzRNzsI1IQiA2eXo0l5kFcu7rd1urAwrp59bXVpKwe/HhfVibTNFV LKy2rvvx4Hj+z6IOkfpeP4Got+KY6RKbKOTbXNabUVyIymkiQSY6J+g+JGU4jEaTxQip 3L2g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=user-agent:content-disposition:mime-version:message-id:subject:cc :to:from:date:dkim-signature:arc-authentication-results; bh=XqUpDrunQN+OPWqgvpZUVcuE+btD8slrQZb3lZMcZlM=; b=QOR4j5ILmwTjAncPGviJ6+H18rh82tOPnEgcjXlu8iU78U1N+6d3jrwf/ADzpUExdw hj/vhFYgn+SfzzsdM4/NjbUHu3eUKeoqyVDrqtGzCWJpcqUQ6axqRIH0NKr7iX3uAsvu zVlJTVk9CIflPOELAvyAYa+X+EF3YMH1Ci0eNL8lrFFZDTtvtaeAtH0icQCII7Gd1zy0 /2ZVg1aaKhMjXQMQ0Q+xq8iW2xWr+gRFlepL3Q9bNz+Ear8UK+ClxUUzWgEjWnifL1lg CkXCPdr4uIcEFDXWovBHQSi2BMB6EuJOCxaOqPcgmzGY5E1STgnndh90VbKUQcfJ+cpV IxAw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=vhVrXT3L; spf=pass (google.com: domain of aishpant@gmail.com designates 209.85.220.65 as permitted sender) smtp.mailfrom=aishpant@gmail.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gmail.com Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=vhVrXT3L; spf=pass (google.com: domain of aishpant@gmail.com designates 209.85.220.65 as permitted sender) smtp.mailfrom=aishpant@gmail.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gmail.com X-Google-Smtp-Source: AH8x224EA34mz8LzGjSN9D5dC0PxiEX36QxZiu+c2XoJt4VJgT5igUlWWtXxeN2niVrkCyHTHKwmWA== Date: Tue, 23 Jan 2018 14:40:32 +0530 From: Aishwarya Pant To: Thomas Maier , Jonathan Corbet , Greg KH , linux-kernel@vger.kernel.org, linux-block@vger.kernel.org Cc: Julia Lawall Subject: [PATCH] Documentation/ABI: clean up sysfs-class-pktcdvd Message-ID: <20180123091032.GA18947@mordor.localdomain> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.9.2 (2017-12-15) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: =?utf-8?q?1590373791370450250?= X-GMAIL-MSGID: =?utf-8?q?1590373791370450250?= X-Mailing-List: linux-kernel@vger.kernel.org List-ID: Clean up the sysfs documentation such that it is in the same format as described in Documentation/ABI/README. Mainly, the patch moves the attribute names to the 'What:' field. This might be useful for scripting and tracking changes in the ABI. Signed-off-by: Aishwarya Pant --- Documentation/ABI/testing/sysfs-class-pktcdvd | 122 +++++++++++++++----------- 1 file changed, 71 insertions(+), 51 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-class-pktcdvd b/Documentation/ABI/testing/sysfs-class-pktcdvd index b1c3f0263359..e85ec99c6e31 100644 --- a/Documentation/ABI/testing/sysfs-class-pktcdvd +++ b/Documentation/ABI/testing/sysfs-class-pktcdvd @@ -1,60 +1,80 @@ -What: /sys/class/pktcdvd/ +sysfs interface +--------------- +The pktcdvd module (packet writing driver) creates the following files in the +sysfs: ( is in format major:minor) + +What: /sys/class/pktcdvd/add +What: /sys/class/pktcdvd/remove +What: /sys/class/pktcdvd/device_map Date: Oct. 2006 KernelVersion: 2.6.20 Contact: Thomas Maier Description: -sysfs interface ---------------- + add: (WO) Write a block device id (major:minor) to create + a new pktcdvd device and map it to the block device. + + remove: (WO) Write the pktcdvd device id (major:minor) to it to + remove the pktcdvd device. + + device_map: (RO) Shows the device mapping in format: + pktcdvd[0-7] + + +What: /sys/class/pktcdvd/pktcdvd[0-7]/dev +What: /sys/class/pktcdvd/pktcdvd[0-7]/uevent +Date: Oct. 2006 +KernelVersion: 2.6.20 +Contact: Thomas Maier +Description: + dev: (RO) Device id + + uevent: (WO) To send an uevent + + +What: /sys/class/pktcdvd/pktcdvd[0-7]/stat/packets_started +What: /sys/class/pktcdvd/pktcdvd[0-7]/stat/packets_finished +What: /sys/class/pktcdvd/pktcdvd[0-7]/stat/kb_written +What: /sys/class/pktcdvd/pktcdvd[0-7]/stat/kb_read +What: /sys/class/pktcdvd/pktcdvd[0-7]/stat/kb_read_gather +What: /sys/class/pktcdvd/pktcdvd[0-7]/stat/reset +Date: Oct. 2006 +KernelVersion: 2.6.20 +Contact: Thomas Maier +Description: + packets_started: (RO) Number of started packets. + + packets_finished: (RO) Number of finished packets. + + kb_written: (RO) kBytes written. + + kb_read: (RO) kBytes read. + + kb_read_gather: (RO) kBytes read to fill write packets. + + reset: (WO) Write any value to it to reset pktcdvd + device statistic values, like bytes + read/written. + + +What: /sys/class/pktcdvd/pktcdvd[0-7]/write_queue/size +What: /sys/class/pktcdvd/pktcdvd[0-7]/write_queue/congestion_off +What: /sys/class/pktcdvd/pktcdvd[0-7]/write_queue/congestion_on +Date: Oct. 2006 +KernelVersion: 2.6.20 +Contact: Thomas Maier +Description: + size: (RO) Contains the size of the bio write queue. + + congestion_off: (RW) If bio write queue size is below this mark, + accept new bio requests from the block layer. -The pktcdvd module (packet writing driver) creates -these files in the sysfs: -( is in format major:minor ) - -/sys/class/pktcdvd/ - add (0200) Write a block device id (major:minor) - to create a new pktcdvd device and map - it to the block device. - - remove (0200) Write the pktcdvd device id (major:minor) - to it to remove the pktcdvd device. - - device_map (0444) Shows the device mapping in format: - pktcdvd[0-7] - -/sys/class/pktcdvd/pktcdvd[0-7]/ - dev (0444) Device id - uevent (0200) To send an uevent. - -/sys/class/pktcdvd/pktcdvd[0-7]/stat/ - packets_started (0444) Number of started packets. - packets_finished (0444) Number of finished packets. - - kb_written (0444) kBytes written. - kb_read (0444) kBytes read. - kb_read_gather (0444) kBytes read to fill write packets. - - reset (0200) Write any value to it to reset - pktcdvd device statistic values, like - bytes read/written. - -/sys/class/pktcdvd/pktcdvd[0-7]/write_queue/ - size (0444) Contains the size of the bio write - queue. - - congestion_off (0644) If bio write queue size is below - this mark, accept new bio requests - from the block layer. - - congestion_on (0644) If bio write queue size is higher - as this mark, do no longer accept - bio write requests from the block - layer and wait till the pktcdvd - device has processed enough bio's - so that bio write queue size is - below congestion off mark. - A value of <= 0 disables congestion - control. + congestion_on: (RW) If bio write queue size is higher as this + mark, do no longer accept bio write requests + from the block layer and wait till the pktcdvd + device has processed enough bio's so that bio + write queue size is below congestion off mark. + A value of <= 0 disables congestion control. Example: -- 2.16.1