diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2021-05-25 14:23:53 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2021-05-27 18:08:05 +0200 |
| commit | 1e03fe240512621605ec47f93dc29994026a2984 (patch) | |
| tree | d52a5c56af671779f2a9d366685085c7684ca0c8 | |
| parent | iio: ABI: sysfs-bus-iio: fix a typo (diff) | |
| download | linux-1e03fe240512621605ec47f93dc29994026a2984.tar.xz linux-1e03fe240512621605ec47f93dc29994026a2984.zip | |
iio: ABI: sysfs-bus-iio: avoid a warning when doc is built
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>
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Link: https://lore.kernel.org/r/dbf0d94f85217f103d77dc8389c8db272f5702d2.1621944866.git.mchehab+huawei@kernel.org
[jc fixed specifiy->specify]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/ABI/testing/sysfs-bus-iio | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index 433fe0ab74be..6f98b6a9b785 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 specify 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 |