Re: [PATCH 26/30] iio: iio.h: fix a warning at the kernel-doc markup
From: Jonathan Cameron <Jonathan.Cameron@Huawei.com>
Date: 2020-09-11 08:34:42
Also in:
lkml
On Wed, 9 Sep 2020 16:10:57 +0200 Mauro Carvalho Chehab [off-list ref] wrote:
There's a warning at iio.h kernel-doc markup:
./include/linux/iio/iio.h:644: WARNING: Unknown target name: "devm".
Because it is using {devm_}foo notation. Well, this is not
a valid kernel-doc notation. Also, it prevents creating hyperlinks
to other documentation functions.
So, replace it to a better notation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Not much going on in that file at the moment, so fine if Jon picks this up directly. Jonathan
quoted hunk ↗ jump to hunk
--- include/linux/iio/iio.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h index e2df67a3b9ab..f1daaba9e706 100644 --- a/include/linux/iio/iio.h +++ b/include/linux/iio/iio.h@@ -641,7 +641,7 @@ static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev) * * This utility must be called between IIO device allocation * (via devm_iio_device_alloc()) & IIO device registration - * (via {devm_}iio_device_register()). + * (via iio_device_register() and devm_iio_device_register())). * By default, the device allocation will also assign a parent device to * the IIO device object. In cases where devm_iio_device_alloc() is used, * sometimes the parent device must be different than the device used to