Re: [PATCH v2 01/29] ABI: sysfs-bus-usb: better document variable argument

From: Bjorn Helgaas
Date: Tue Sep 14 2021 - 14:58:03 EST


On Tue, Sep 14, 2021 at 04:32:16PM +0200, Mauro Carvalho Chehab wrote:
> 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@xxxxxxxxxx>

Acked-by: Bjorn Helgaas <bhelgaas@xxxxxxxxxx>

> ---
> 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@xxxxxxxxx>
> 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@xxxxxxxxx>
> 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@xxxxxxx>
> 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@xxxxxxxxxxxx>
> 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@xxxxxxxxxxx>
> 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@xxxxxxxxxxxxxxx>
> Description:
> --
> 2.31.1
>