linux-kernel - Re: [PATCH 4/9] ABI: sysfs-bus-usb: better document variable argument

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <YT88IYrNS4a48aPK@kuha.fi.intel.com>
Date:   Mon, 13 Sep 2021 14:55:13 +0300
From:   Heikki Krogerus <heikki.krogerus@...ux.intel.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Greg KH <gregkh@...uxfoundation.org>,
        Jonathan Corbet <corbet@....net>,
        Ilya Dryomov <idryomov@...il.com>,
        Jonathan Cameron <Jonathan.Cameron@...wei.com>,
        Rajat Jain <rajatja@...gle.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 4/9] ABI: sysfs-bus-usb: better document variable argument

On Wed, Sep 08, 2021 at 04:58:51PM +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@...nel.org>

Acked-by: Heikki Krogerus <heikki.krogerus@...ux.intel.com>

> ---
>  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@...el.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@...el.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@...k.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@...omium.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@...data.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@...ux.intel.com>
>  Description:
> -- 
> 2.31.1

-- 
heikki