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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxx>
Reported-by: Matthew Wilcox <willy@xxxxxxxxxxxxx>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
---
 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@xxxxxxxxxxxxxxx
 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




[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Input]     [Linux Kernel]     [Linux SCSI]     [X.org]

  Powered by Linux