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

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

[Manuel Ebner]

Fix missing and needless brackets and bracelets.
Fix minor grammar issues.

Signed-off-by: Manuel Ebner <manuelebner@mailbox.org>
---
[v1] -> [v2]
change from removing single bracket to adding missing bracket
add recipients
 Thanks Jonathan for researching the e-mail addresses.
use proper english punctuation in changelog
"is 64 bit counter" -> "is a 64-bit counter"

---
 Documentation/ABI/stable/sysfs-class-infiniband      |  8 ++++----
 Documentation/ABI/testing/sysfs-bus-iio              | 10 +++++-----
 Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192   |  2 +-
 Documentation/ABI/testing/sysfs-firmware-dmi-entries |  2 +-
 Documentation/ABI/testing/sysfs-firmware-gsmi        |  2 +-
 Documentation/ABI/testing/sysfs-uevent               |  2 +-
 6 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/Documentation/ABI/stable/sysfs-class-infiniband b/Documentation/ABI/stable/sysfs-class-infiniband
index 694f23a03a28..7ba116103429 100644
--- a/Documentation/ABI/stable/sysfs-class-infiniband
+++ b/Documentation/ABI/stable/sysfs-class-infiniband
@@ -148,17 +148,17 @@ Description:
 		**Data info**:
 
 		port_xmit_data: (RO) Total number of data octets, divided by 4
-		(lanes), transmitted on all VLs. This is 64 bit counter
+		(lanes), transmitted on all VLs. This is a 64-bit counter
 
 		port_rcv_data: (RO) Total number of data octets, divided by 4
-		(lanes), received on all VLs. This is 64 bit counter.
+		(lanes), received on all VLs. This is a 64-bit counter.
 
 		port_xmit_packets: (RO) Total number of packets transmitted on
 		all VLs from this port. This may include packets with errors.
-		This is 64 bit counter.
+		This is a 64-bit counter.
 
 		port_rcv_packets: (RO) Total number of packets (this may include
-		packets containing Errors. This is 64 bit counter.
+		packets containing Errors). This is a 64-bit counter.
 
 		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 b/Documentation/ABI/testing/sysfs-bus-iio
index d8d6d85235b0..4ea5598e7cd2 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -917,7 +917,7 @@ Description:
 
 		Note the driver will assume the last p events requested are
 		to be enabled where p is how many it supports (which may vary
-		depending on the exact set requested. So if you want to be
+		depending on the exact set requested). So if you want to be
 		sure you have set what you think you have, check the contents of
 		these attributes after everything is configured. Drivers may
 		have to buffer any parameters so that they are consistent when
@@ -973,7 +973,7 @@ Description:
 
 		Note the driver will assume the last p events requested are
 		to be enabled where p is however many it supports (which may
-		vary depending on the exact set requested. So if you want to be
+		vary depending on the exact set requested). So if you want to be
 		sure you have set what you think you have, check the contents of
 		these attributes after everything is configured. Drivers may
 		have to buffer any parameters so that they are consistent when
@@ -1528,9 +1528,9 @@ Description:
 		the unused bits, so to get a clean value the bits value must be
 		used to mask the buffer output value appropriately. The storagebits
 		value also specifies the data alignment. So s48/64>>2 will be a
-		signed 48 bit integer stored in a 64 bit location aligned to a 64
-		bit boundary. To obtain the clean value, shift right 2 and apply a
-		mask to zero the top 16 bits of the result.
+		signed 48-bit integer stored in a 64-bit location aligned to a
+		64-bit boundary. To obtain the clean value, shift right 2 and apply
+		a mask to zero the top 16 bits of the result.
 		For other storage combinations this attribute will be extended
 		appropriately.
 
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
index 28be1cabf112..d44eb5f8728b 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.
 
 What:		/sys/bus/iio/devices/iio:deviceX/in_voltage2-voltage2_shorted_raw
diff --git a/Documentation/ABI/testing/sysfs-firmware-dmi-entries b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
index b6c23807b804..ed7d9d06a9ff 100644
--- a/Documentation/ABI/testing/sysfs-firmware-dmi-entries
+++ b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
@@ -93,7 +93,7 @@ Description:
 		  /sys/firmware/dmi/entries/15-0/system_event_log
 
 		and has the following attributes (documented in the
-		SMBIOS / DMI specification under "System Event Log (Type 15)":
+		SMBIOS / DMI specification under "System Event Log (Type 15)"):
 
 		- area_length
 		- header_start_offset
diff --git a/Documentation/ABI/testing/sysfs-firmware-gsmi b/Documentation/ABI/testing/sysfs-firmware-gsmi
index 7a558354c1ee..3b3c3ae6f458 100644
--- a/Documentation/ABI/testing/sysfs-firmware-gsmi
+++ b/Documentation/ABI/testing/sysfs-firmware-gsmi
@@ -19,7 +19,7 @@ Description:
 		/sys/firmware/gsmi/vars:
 
 			This directory has the same layout (and
-			underlying implementation as /sys/firmware/efi/vars.
+			underlying implementation) as /sys/firmware/efi/vars.
 			See `Documentation/ABI/*/sysfs-firmware-efi-vars`
 			for more information on how to interact with
 			this structure.
diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
index 0b6227706b35..c15e18c47a0e 100644
--- a/Documentation/ABI/testing/sysfs-uevent
+++ b/Documentation/ABI/testing/sysfs-uevent
@@ -8,7 +8,7 @@ Description:
 
                 Recognized extended format is::
 
-			ACTION [UUID [KEY=VALUE ...]
+			ACTION [UUID [KEY=VALUE ...]]
 
                 The ACTION is compulsory - it is the name of the uevent
                 action (``add``, ``change``, ``remove``). There is no change
-- 
2.54.0

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

[Jonathan Cameron]

On Fri, 12 Jun 2026 09:49:18 +0200
Manuel Ebner <manuelebner@mailbox.org> wrote:

> Fix missing and needless brackets and bracelets.
> Fix minor grammar issues.
> 
> Signed-off-by: Manuel Ebner <manuelebner@mailbox.org>
I guess I was unclear in my v1 review. This needs to be split up by subsystem
to which a patch applies.  Each change will probably take a different route to
upstream as other changes in these files that may clash will generally be routed
via the appropriate subsystem.

The two IIO files can be one patch, but others should all be one
patch per file touched.

Thanks,

Jonathan

> ---
> [v1] -> [v2]
> change from removing single bracket to adding missing bracket
> add recipients
>  Thanks Jonathan for researching the e-mail addresses.
> use proper english punctuation in changelog
> "is 64 bit counter" -> "is a 64-bit counter"
> 
> ---
>  Documentation/ABI/stable/sysfs-class-infiniband      |  8 ++++----
>  Documentation/ABI/testing/sysfs-bus-iio              | 10 +++++-----
>  Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192   |  2 +-
>  Documentation/ABI/testing/sysfs-firmware-dmi-entries |  2 +-
>  Documentation/ABI/testing/sysfs-firmware-gsmi        |  2 +-
>  Documentation/ABI/testing/sysfs-uevent               |  2 +-
>  6 files changed, 13 insertions(+), 13 deletions(-)
> 
> diff --git a/Documentation/ABI/stable/sysfs-class-infiniband b/Documentation/ABI/stable/sysfs-class-infiniband
> index 694f23a03a28..7ba116103429 100644
> --- a/Documentation/ABI/stable/sysfs-class-infiniband
> +++ b/Documentation/ABI/stable/sysfs-class-infiniband
> @@ -148,17 +148,17 @@ Description:
>  		**Data info**:
>  
>  		port_xmit_data: (RO) Total number of data octets, divided by 4
> -		(lanes), transmitted on all VLs. This is 64 bit counter
> +		(lanes), transmitted on all VLs. This is a 64-bit counter
>  
>  		port_rcv_data: (RO) Total number of data octets, divided by 4
> -		(lanes), received on all VLs. This is 64 bit counter.
> +		(lanes), received on all VLs. This is a 64-bit counter.
>  
>  		port_xmit_packets: (RO) Total number of packets transmitted on
>  		all VLs from this port. This may include packets with errors.
> -		This is 64 bit counter.
> +		This is a 64-bit counter.
>  
>  		port_rcv_packets: (RO) Total number of packets (this may include
> -		packets containing Errors. This is 64 bit counter.
> +		packets containing Errors). This is a 64-bit counter.
>  
>  		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 b/Documentation/ABI/testing/sysfs-bus-iio
> index d8d6d85235b0..4ea5598e7cd2 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -917,7 +917,7 @@ Description:
>  
>  		Note the driver will assume the last p events requested are
>  		to be enabled where p is how many it supports (which may vary
> -		depending on the exact set requested. So if you want to be
> +		depending on the exact set requested). So if you want to be
>  		sure you have set what you think you have, check the contents of
>  		these attributes after everything is configured. Drivers may
>  		have to buffer any parameters so that they are consistent when
> @@ -973,7 +973,7 @@ Description:
>  
>  		Note the driver will assume the last p events requested are
>  		to be enabled where p is however many it supports (which may
> -		vary depending on the exact set requested. So if you want to be
> +		vary depending on the exact set requested). So if you want to be
>  		sure you have set what you think you have, check the contents of
>  		these attributes after everything is configured. Drivers may
>  		have to buffer any parameters so that they are consistent when
> @@ -1528,9 +1528,9 @@ Description:
>  		the unused bits, so to get a clean value the bits value must be
>  		used to mask the buffer output value appropriately. The storagebits
>  		value also specifies the data alignment. So s48/64>>2 will be a
> -		signed 48 bit integer stored in a 64 bit location aligned to a 64
> -		bit boundary. To obtain the clean value, shift right 2 and apply a
> -		mask to zero the top 16 bits of the result.
> +		signed 48-bit integer stored in a 64-bit location aligned to a
> +		64-bit boundary. To obtain the clean value, shift right 2 and apply
> +		a mask to zero the top 16 bits of the result.
>  		For other storage combinations this attribute will be extended
>  		appropriately.
>  
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
> index 28be1cabf112..d44eb5f8728b 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.
>  
>  What:		/sys/bus/iio/devices/iio:deviceX/in_voltage2-voltage2_shorted_raw
> diff --git a/Documentation/ABI/testing/sysfs-firmware-dmi-entries b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> index b6c23807b804..ed7d9d06a9ff 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> +++ b/Documentation/ABI/testing/sysfs-firmware-dmi-entries
> @@ -93,7 +93,7 @@ Description:
>  		  /sys/firmware/dmi/entries/15-0/system_event_log
>  
>  		and has the following attributes (documented in the
> -		SMBIOS / DMI specification under "System Event Log (Type 15)":
> +		SMBIOS / DMI specification under "System Event Log (Type 15)"):
>  
>  		- area_length
>  		- header_start_offset
> diff --git a/Documentation/ABI/testing/sysfs-firmware-gsmi b/Documentation/ABI/testing/sysfs-firmware-gsmi
> index 7a558354c1ee..3b3c3ae6f458 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-gsmi
> +++ b/Documentation/ABI/testing/sysfs-firmware-gsmi
> @@ -19,7 +19,7 @@ Description:
>  		/sys/firmware/gsmi/vars:
>  
>  			This directory has the same layout (and
> -			underlying implementation as /sys/firmware/efi/vars.
> +			underlying implementation) as /sys/firmware/efi/vars.
>  			See `Documentation/ABI/*/sysfs-firmware-efi-vars`
>  			for more information on how to interact with
>  			this structure.
> diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
> index 0b6227706b35..c15e18c47a0e 100644
> --- a/Documentation/ABI/testing/sysfs-uevent
> +++ b/Documentation/ABI/testing/sysfs-uevent
> @@ -8,7 +8,7 @@ Description:
>  
>                  Recognized extended format is::
>  
> -			ACTION [UUID [KEY=VALUE ...]
> +			ACTION [UUID [KEY=VALUE ...]]
>  
>                  The ACTION is compulsory - it is the name of the uevent
>                  action (``add``, ``change``, ``remove``). There is no change