Re: [PATCH] Documentation: ABI: fix brackets and bracelets

[Jonathan Cameron]

On Thu, 11 Jun 2026 10:56:21 +0200
Manuel Ebner <manuelebner@xxxxxxxxxxx> wrote:

> Fix missing and needless brackets
> Fix missing bracelets
> 
> Signed-off-by: Manuel Ebner <manuelebner@xxxxxxxxxxx>
> ---
>  Documentation/ABI/stable/sysfs-class-infiniband      | 4 ++--
>  Documentation/ABI/testing/sysfs-bus-iio              | 4 ++--
>  Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192   | 2 +-

Take a look at hos this stuff is routed into upstream.  Each 
subsystem 'owns' their own documentation.  So this needs splitting up
on a per subsystem basis.  I'll also note that you've only +CC IIO folk
so you aren't going to get much review on the rest!

A few comments inline.

>  Documentation/ABI/testing/sysfs-firmware-dmi-entries | 2 +-
>  Documentation/ABI/testing/sysfs-firmware-gsmi        | 2 +-
>  Documentation/ABI/testing/sysfs-uevent               | 2 +-
>  6 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/ABI/stable/sysfs-class-infiniband b/Documentation/ABI/stable/sysfs-class-infiniband
> index 694f23a03a28..e48a0d2fb4e5 100644
> --- a/Documentation/ABI/stable/sysfs-class-infiniband
> +++ b/Documentation/ABI/stable/sysfs-class-infiniband
> @@ -157,8 +157,8 @@ Description:
>  		all VLs from this port. This may include packets with errors.
>  		This is 64 bit counter.
>  
> -		port_rcv_packets: (RO) Total number of packets (this may include
> -		packets containing Errors. This is 64 bit counter.
> +		port_rcv_packets: (RO) Total number of packets, this may include
> +		packets containing Errors. This is a 64 bit counter.
Comma doesn't feel like the right choice here.  Perhaps,

		port_rc_packets: (RO) Total number of packets. May include
		packets containing Errors. This is a 64 bit counter.

Or just add the closing bracket.

>  
>  		link_downed: (RO) Total number of times the Port Training state
>  		machine has failed the link error recovery process and downed
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
> index 28be1cabf112..108ea0abbdb6 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
> @@ -16,7 +16,7 @@ Description:
>  		In bridge applications, such as strain gauges and load cells,
>  		the bridge itself consumes the majority of the current in the
>  		system. To minimize the current consumption of the system,
> -		the bridge can be disconnected (when it is not being used
> +		the bridge can be disconnected when it is not being used
>  		using the bridge_switch_en attribute.

I think intent would be better reflected here by adding the closing )
That last bit is kind of a 'by the way' rather than the dominant point of
the sentence.

>  
>  What:		/sys/bus/iio/devices/iio:deviceX/in_voltage2-voltage2_shorted_raw

> diff --git a/Documentation/ABI/testing/sysfs-firmware-gsmi b/Documentation/ABI/testing/sysfs-firmware-gsmi
> index 7a558354c1ee..88ca75d323d1 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-gsmi
> +++ b/Documentation/ABI/testing/sysfs-firmware-gsmi
> @@ -18,7 +18,7 @@ Description:
>  
>  		/sys/firmware/gsmi/vars:
>  
> -			This directory has the same layout (and
> +			This directory has the same layout and
>  			underlying implementation as /sys/firmware/efi/vars.
>  			See `Documentation/ABI/*/sysfs-firmware-efi-vars`
>  			for more information on how to interact with
I think I'd add the bracket after implementation as this file is about ABI
so that's less important than the rest of the sentence.