include/linux/iio/iio-gts-helper.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
The kerneldoc for iio_gts_find_sel_by_int_time() has an error.
Documentation states that function is searching a selector for a HW-gain
while it is searching a selector for an integration time.
Fix the documentation by saying the function is looking for a selector
for an integration time.
Signed-off-by: Matti Vaittinen <mazziesaccount@gmail.com>
---
include/linux/iio/iio-gts-helper.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/iio/iio-gts-helper.h b/include/linux/iio/iio-gts-helper.h
index dd64e544a3da..9cb6c80dea71 100644
--- a/include/linux/iio/iio-gts-helper.h
+++ b/include/linux/iio/iio-gts-helper.h
@@ -135,7 +135,7 @@ static inline int iio_gts_find_int_time_by_sel(struct iio_gts *gts, int sel)
/**
* iio_gts_find_sel_by_int_time - find selector matching integration time
* @gts: Gain time scale descriptor
- * @gain: HW-gain for which matching selector is searched for
+ * @time: Integration time for which matching selector is searched for
*
* Return: a selector matching given integration time or -EINVAL if
* selector was not found.
base-commit: 52cc189b4fc6af6accc45fe7b7053d76d8724059
--
2.40.0
--
Matti Vaittinen, Linux device drivers
ROHM Semiconductors, Finland SWDC
Kiviharjunlenkki 1E
90220 OULU
FINLAND
~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~
Simon says - in Latin please.
~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~
Thanks to Simon Glass for the translation =]
On Fri, 21 Apr 2023 08:46:11 +0300 Matti Vaittinen <mazziesaccount@gmail.com> wrote: > The kerneldoc for iio_gts_find_sel_by_int_time() has an error. > Documentation states that function is searching a selector for a HW-gain > while it is searching a selector for an integration time. > > Fix the documentation by saying the function is looking for a selector > for an integration time. > > Signed-off-by: Matti Vaittinen <mazziesaccount@gmail.com> Given this is a very recent introduction and I don't like incorrect docs sneaking in, I've applied this to the fixes-togreg branch of iio.git (which just got rebased on char-misc-linus which now includes this code). Thanks, Jonathan > --- > include/linux/iio/iio-gts-helper.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/linux/iio/iio-gts-helper.h b/include/linux/iio/iio-gts-helper.h > index dd64e544a3da..9cb6c80dea71 100644 > --- a/include/linux/iio/iio-gts-helper.h > +++ b/include/linux/iio/iio-gts-helper.h > @@ -135,7 +135,7 @@ static inline int iio_gts_find_int_time_by_sel(struct iio_gts *gts, int sel) > /** > * iio_gts_find_sel_by_int_time - find selector matching integration time > * @gts: Gain time scale descriptor > - * @gain: HW-gain for which matching selector is searched for > + * @time: Integration time for which matching selector is searched for > * > * Return: a selector matching given integration time or -EINVAL if > * selector was not found. > > base-commit: 52cc189b4fc6af6accc45fe7b7053d76d8724059
© 2016 - 2025 Red Hat, Inc.