linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	Bjorn Helgaas <bhelgaas@google.com>,
	Heikki Krogerus <heikki.krogerus@linux.intel.com>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Rajat Jain <rajatja@google.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 01/29] ABI: sysfs-bus-usb: better document variable argument
Date: Tue, 14 Sep 2021 16:32:16 +0200	[thread overview]
Message-ID: <cf40784dd4169897f7a28cc4d9393e8eaae5b873.1631629496.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1631629496.git.mchehab+huawei@kernel.org>

On almost all ABI documents, variable arguments are declared
as <foo_bar>. Change it here too, in order to allow replacing
such wildcards by regexes on a scriptable way.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/ABI/testing/sysfs-bus-usb | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-usb b/Documentation/ABI/testing/sysfs-bus-usb
index 73eb23bc1f34..42103f0f54d6 100644
--- a/Documentation/ABI/testing/sysfs-bus-usb
+++ b/Documentation/ABI/testing/sysfs-bus-usb
@@ -166,14 +166,14 @@ Description:
 		The file will be present for all speeds of USB devices, and will
 		always read "no" for USB 1.1 and USB 2.0 devices.
 
-What:		/sys/bus/usb/devices/.../(hub interface)/portX
+What:		/sys/bus/usb/devices/.../<hub_interface>/port<X>
 Date:		August 2012
 Contact:	Lan Tianyu <tianyu.lan@intel.com>
 Description:
-		The /sys/bus/usb/devices/.../(hub interface)/portX
+		The /sys/bus/usb/devices/.../<hub_interface>/port<X>
 		is usb port device's sysfs directory.
 
-What:		/sys/bus/usb/devices/.../(hub interface)/portX/connect_type
+What:		/sys/bus/usb/devices/.../<hub_interface>/port<X>/connect_type
 Date:		January 2013
 Contact:	Lan Tianyu <tianyu.lan@intel.com>
 Description:
@@ -182,7 +182,7 @@ Description:
 		The file will read "hotplug", "hardwired" and "not used" if the
 		information is available, and "unknown" otherwise.
 
-What:		/sys/bus/usb/devices/.../(hub interface)/portX/location
+What:		/sys/bus/usb/devices/.../<hub_interface>/port<X>/location
 Date:		October 2018
 Contact:	Bjørn Mork <bjorn@mork.no>
 Description:
@@ -192,7 +192,7 @@ Description:
 		raw location value as a hex integer.
 
 
-What:		/sys/bus/usb/devices/.../(hub interface)/portX/quirks
+What:		/sys/bus/usb/devices/.../<hub_interface>/port<X>/quirks
 Date:		May 2018
 Contact:	Nicolas Boichat <drinkcat@chromium.org>
 Description:
@@ -216,7 +216,7 @@ Description:
 		   used to help make enumeration work better on some high speed
 		   devices.
 
-What:		/sys/bus/usb/devices/.../(hub interface)/portX/over_current_count
+What:		/sys/bus/usb/devices/.../<hub_interface>/port<X>/over_current_count
 Date:		February 2018
 Contact:	Richard Leitner <richard.leitner@skidata.com>
 Description:
@@ -230,10 +230,10 @@ Description:
 		Any time this value changes the corresponding hub device will send a
 		udev event with the following attributes::
 
-		  OVER_CURRENT_PORT=/sys/bus/usb/devices/.../(hub interface)/portX
+		  OVER_CURRENT_PORT=/sys/bus/usb/devices/.../<hub_interface>/port<X>
 		  OVER_CURRENT_COUNT=[current value of this sysfs attribute]
 
-What:		/sys/bus/usb/devices/.../(hub interface)/portX/usb3_lpm_permit
+What:		/sys/bus/usb/devices/.../<hub_interface>/port<X>/usb3_lpm_permit
 Date:		November 2015
 Contact:	Lu Baolu <baolu.lu@linux.intel.com>
 Description:
-- 
2.31.1


  reply	other threads:[~2021-09-14 14:35 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-14 14:32 [PATCH v2 00/29] Change wildcards on ABI files Mauro Carvalho Chehab
2021-09-14 14:32 ` Mauro Carvalho Chehab [this message]
2021-09-14 17:31   ` [PATCH v2 01/29] ABI: sysfs-bus-usb: better document variable argument Rajat Jain
2021-09-14 18:57   ` Bjorn Helgaas
2021-09-14 14:32 ` [PATCH v2 02/29] ABI: sysfs-tty: better document module name parameter Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 03/29] ABI: sysfs-kernel-slab: use a wildcard for the cache name Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 04/29] ABI: security: fix location for evm and ima_policy Mauro Carvalho Chehab
2021-09-14 15:53   ` Mimi Zohar
2021-09-14 14:32 ` [PATCH v2 05/29] ABI: sysfs-class-tpm: use wildcards for pcr-* nodes Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 06/29] ABI: sysfs-bus-rapidio: use wildcards on What definitions Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 07/29] ABI: sysfs-class-cxl: place "not in a guest" at description Mauro Carvalho Chehab
2021-09-15  3:33   ` Andrew Donnellan
2021-09-14 14:32 ` [PATCH v2 08/29] ABI: sysfs-class-devfreq-event: use the right wildcards on What Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 09/29] ABI: sysfs-class-mic: use the right wildcards on What definitions Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 10/29] ABI: pstore: Fix What field Mauro Carvalho Chehab
2021-09-14 17:35   ` Kees Cook
2021-09-14 14:32 ` [PATCH v2 11/29] ABI: sysfs-class-typec: fix a bad " Mauro Carvalho Chehab
2021-09-14 14:45   ` Heikki Krogerus
2021-09-14 14:32 ` [PATCH v2 12/29] ABI: sysfs-ata: use a proper wildcard for ata_* Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 13/29] ABI: sysfs-class-infiniband: use wildcards on What definitions Mauro Carvalho Chehab
2021-09-14 17:13   ` Jason Gunthorpe
2021-09-14 14:32 ` [PATCH v2 14/29] ABI: sysfs-bus-pci: " Mauro Carvalho Chehab
2021-09-14 18:57   ` Bjorn Helgaas
2021-09-14 14:32 ` [PATCH v2 15/29] ABI: sysfs-bus-soundwire-master: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 16/29] ABI: sysfs-bus-soundwire-slave: " Mauro Carvalho Chehab
2021-09-14 15:28   ` Pierre-Louis Bossart
2021-09-14 14:32 ` [PATCH v2 17/29] ABI: sysfs-class-gnss: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 18/29] ABI: sysfs-class-mei: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 19/29] ABI: sysfs-class-mux: " Mauro Carvalho Chehab
2021-09-15  8:00   ` Peter Rosin
2021-09-14 14:32 ` [PATCH v2 20/29] ABI: sysfs-class-pwm: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 21/29] ABI: sysfs-class-rc: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 22/29] ABI: sysfs-class-rc-nuvoton: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 23/29] ABI: sysfs-class-uwb_rc: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 24/29] ABI: sysfs-class-uwb_rc-wusbhc: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 25/29] ABI: sysfs-devices-platform-dock: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 26/29] ABI: sysfs-devices-system-cpu: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 27/29] ABI: sysfs-firmware-efi-esrt: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 28/29] ABI: sysfs-platform-sst-atom: " Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 29/29] ABI: sysfs-ptp: " Mauro Carvalho Chehab
2021-09-14 14:47   ` Richard Cochran

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=cf40784dd4169897f7a28cc4d9393e8eaae5b873.1631629496.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=heikki.krogerus@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rajatja@google.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;
as well as URLs for NNTP newsgroup(s).