OSDN Git Service

iio: ABI: sysfs-bus-iio: avoid a warning when doc is built
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 25 May 2021 12:23:53 +0000 (14:23 +0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 27 May 2021 16:08:05 +0000 (10:08 -0600)
commit1e03fe240512621605ec47f93dc29994026a2984
treed52a5c56af671779f2a9d366685085c7684ca0c8
parentb77e4c4e655b455c4aba196838d1102c0e3414a4
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>
Documentation/ABI/testing/sysfs-bus-iio