[PATCH 0/2] doc: add a couple fixups for IIO ABI files

[PATCH 0/2] doc: add a couple fixups for IIO ABI files

[Mauro Carvalho Chehab]

Patch 1 was already submitted as patch 10/10 on this series:
	https://lore.kernel.org/linux-doc/87wnrtnpko.fsf@meer.lwn.net/

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(-)

-- 
2.31.1

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

[Mauro Carvalho Chehab]

Descrption -> Description

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

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/ABI/testing/sysfs-bus-iio | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 267973541e72..433fe0ab74be 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -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:	linux-iio@vger.kernel.org
-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:	linux-iio@vger.kernel.org
-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
-- 
2.31.1

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

[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.

Reported-by: Jonathan Corbet <corbet@lwn.net>
Reported-by: Matthew Wilcox <willy@infradead.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/ABI/testing/sysfs-bus-iio | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 433fe0ab74be..dcc52828a204 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -801,7 +801,7 @@ Contact:	linux-iio@vger.kernel.org
 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
-- 
2.31.1

Re: [PATCH 0/2] doc: add a couple fixups for IIO ABI files

[Jonathan Cameron]

On Tue, 25 May 2021 14:23:51 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> Patch 1 was already submitted as patch 10/10 on this series:
> 	https://lore.kernel.org/linux-doc/87wnrtnpko.fsf@meer.lwn.net/
> 
> 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.

Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

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

Thanks!

> 
> 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(-)
> 

Re: [PATCH 0/2] doc: add a couple fixups for IIO ABI files

[Jonathan Corbet]

Jonathan Cameron <jic23@kernel.org> writes:

> On Tue, 25 May 2021 14:23:51 +0200
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
>
>> Patch 1 was already submitted as patch 10/10 on this series:
>> 	https://lore.kernel.org/linux-doc/87wnrtnpko.fsf@meer.lwn.net/
>> 
>> 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.
>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> 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