Skip to contentSkip to conversation

doc: add a couple fixups for IIO ABI files

PATCH Applied Mauro Carvalho Chehab 3 participants 5 messages May 25, 2021 – May 27, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

cover doc: add a couple fixups for IIO ABI files

Patch 1 was already submitted as patch 10/10 on this series:
https://lore.kernel.org/linux-doc/[email protected]/

However, it generated a new warning, due to a separate issue.

So, resend it together with a warning fix patch.

As these patches are independent from the other ones, I guess it can either be applied via IIO or via docs tree, whatever works best for the doc and IIO maintainers.
So, I should leave such decision to Jonathan & Jonathan ;-)

Mauro Carvalho Chehab (2):
iio: ABI: sysfs-bus-iio: fix a typo
iio: ABI: sysfs-bus-iio: avoid a warning when doc is built

 Documentation/ABI/testing/sysfs-bus-iio | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Signature · 1 line
2.31.1
#1 lore raw

PATCH 1/2 iio: ABI: sysfs-bus-iio: fix a typo

Descrption -> Description

This causes some errors when parsed via scripts/get_abi.pl.

---
 Documentation/ABI/testing/sysfs-bus-iio | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-bus-iio +2 -2
index 267973541e72..433fe0ab74be 100644
@@ -786,7 +786,7 @@ What:		/sys/.../events/in_capacitanceY_adaptive_thresh_rising_en
 What:		/sys/.../events/in_capacitanceY_adaptive_thresh_falling_en
 KernelVersion:	5.13
 Contact:	[email protected]
-Descrption:
+Description:
 		Adaptive thresholds are similar to normal fixed thresholds
 		but the value is expressed as an offset from a value which
 		provides a low frequency approximation of the channel itself.
@@ -798,7 +798,7 @@ What:		/sys/.../in_capacitanceY_adaptive_thresh_rising_timeout
 What:		/sys/.../in_capacitanceY_adaptive_thresh_falling_timeout
 KernelVersion:	5.11
 Contact:	[email protected]
-Descrption:
+Description:
 		When adaptive thresholds are used, the tracking signal
 		may adjust too slowly to step changes in the raw signal.
 		*_timeout (in seconds) specifies a time for which the
Signature · 1 line
2.31.1
#2 lore raw

PATCH 2/2 iio: ABI: sysfs-bus-iio: avoid a warning when doc is built

In reply to Mauro Carvalho Chehab

The description of those vars produce this warning:
Documentation/ABI/testing/sysfs-bus-iio:799: WARNING: Inline emphasis start-string without end-string.

Due to an asterisk, which is the markup for emphasis. One possible fix would be to use ``*_timeout`` to avoid it, but looking at the descriptions of other fields in this file, a common pattern is to refer to "these" when talking about the API calls that are described.

So, change the text in order to preserve the meaning while avoiding the need of using an asterisk there.

---
 Documentation/ABI/testing/sysfs-bus-iio | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-bus-iio +1 -1
index 433fe0ab74be..dcc52828a204 100644
@@ -801,7 +801,7 @@ Contact:	[email protected]
 Description:
 		When adaptive thresholds are used, the tracking signal
 		may adjust too slowly to step changes in the raw signal.
-		*_timeout (in seconds) specifies a time for which the
+		Thus these specifiy the time in seconds for which the
 		difference between the slow tracking signal and the raw
 		signal is allowed to remain out-of-range before a reset
 		event occurs in which the tracking signal is made equal
Signature · 1 line
2.31.1
maintainer Acked-by on the v1 series
#3 lore raw
In reply to Mauro Carvalho Chehab
Quoted 11 lines · On Tue, 25 May 2021 14:23:51 +0200 Mauro Carvalho Chehab…

Patch 1 was already submitted as patch 10/10 on this series:
https://lore.kernel.org/linux-doc/[email protected]/

However, it generated a new warning, due to a separate issue.

So, resend it together with a warning fix patch.

As these patches are independent from the other ones, I guess it can either be applied via IIO or via docs tree, whatever works best for the doc and IIO maintainers.
So, I should leave such decision to Jonathan & Jonathan ;-)

Either works for me, but on basis I got here first.

Jon, if you'd prefer I picked these up, then let me know.

Thanks!

Quoted 8 lines

Mauro Carvalho Chehab (2):
iio: ABI: sysfs-bus-iio: fix a typo
iio: ABI: sysfs-bus-iio: avoid a warning when doc is built

 Documentation/ABI/testing/sysfs-bus-iio | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
maintainer Applied
#4 lore raw
Quoted 15 lines · Jonathan Cameron
Quoted 11 lines · On Tue, 25 May 2021 14:23:51 +0200 Mauro Carvalho Chehab…

Patch 1 was already submitted as patch 10/10 on this series:
https://lore.kernel.org/linux-doc/[email protected]/

However, it generated a new warning, due to a separate issue.

So, resend it together with a warning fix patch.

As these patches are independent from the other ones, I guess it can either be applied via IIO or via docs tree, whatever works best for the doc and IIO maintainers.
So, I should leave such decision to Jonathan & Jonathan ;-)

Quoted 5 lines

Either works for me, but on basis I got here first.

Jon, if you'd prefer I picked these up, then let me know.

I've applied them, thanks; I took the liberty of fixing the spelling of "specify" in the second one :)

jon