[v2] Documentation: iio: fix typo in triggered-buffers example

[PATCH v2] Documentation: iio: fix typo in triggered-buffers example

Posted by Stepan Ionichev 4 weeks, 1 day ago

In the "IIO triggered buffer setup" example, iio_triggered_buffer_setup()
is called with "sensor_iio_polfunc" (single 'l') while the function is
defined and later referenced as "sensor_iio_pollfunc" (double 'l'). Fix
the misspelling so the example is consistent.

Signed-off-by: Stepan Ionichev <sozdayvek@gmail.com>
---
v2:
- Drop the file name and line numbers from the commit body, refer
  to the example by its section name instead (per Andy)

 Documentation/driver-api/iio/triggered-buffers.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/iio/triggered-buffers.rst b/Documentation/driver-api/iio/triggered-buffers.rst
index 417555dbb..23b82357e 100644
--- a/Documentation/driver-api/iio/triggered-buffers.rst
+++ b/Documentation/driver-api/iio/triggered-buffers.rst
@@ -43,7 +43,7 @@ A typical triggered buffer setup looks like this::
     }
 
     /* setup triggered buffer, usually in probe function */
-    iio_triggered_buffer_setup(indio_dev, sensor_iio_polfunc,
+    iio_triggered_buffer_setup(indio_dev, sensor_iio_pollfunc,
                                sensor_trigger_handler,
                                sensor_buffer_setup_ops);
 
-- 
2.43.0

Re: [PATCH v2] Documentation: iio: fix typo in triggered-buffers example

Posted by Andy Shevchenko 4 weeks ago

On Thu, May 14, 2026 at 01:51:57PM +0500, Stepan Ionichev wrote:
> In the "IIO triggered buffer setup" example, iio_triggered_buffer_setup()
> is called with "sensor_iio_polfunc" (single 'l') while the function is
> defined and later referenced as "sensor_iio_pollfunc" (double 'l'). Fix
> the misspelling so the example is consistent.

Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2] Documentation: iio: fix typo in triggered-buffers example

Posted by Jonathan Cameron 3 weeks, 6 days ago

On Fri, 15 May 2026 13:59:06 +0300
Andy Shevchenko <andriy.shevchenko@intel.com> wrote:

> On Thu, May 14, 2026 at 01:51:57PM +0500, Stepan Ionichev wrote:
> > In the "IIO triggered buffer setup" example, iio_triggered_buffer_setup()
> > is called with "sensor_iio_polfunc" (single 'l') while the function is
> > defined and later referenced as "sensor_iio_pollfunc" (double 'l'). Fix
> > the misspelling so the example is consistent.  
> 
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
> 

Applied.
Thanks,
J

Re: [PATCH v2] Documentation: iio: fix typo in triggered-buffers example

Posted by Joshua Crofts 4 weeks, 1 day ago

On Thu, 14 May 2026 at 10:53, Stepan Ionichev <sozdayvek@gmail.com> wrote:
>
> In the "IIO triggered buffer setup" example, iio_triggered_buffer_setup()
> is called with "sensor_iio_polfunc" (single 'l') while the function is
> defined and later referenced as "sensor_iio_pollfunc" (double 'l'). Fix
> the misspelling so the example is consistent.
>
> Signed-off-by: Stepan Ionichev <sozdayvek@gmail.com>
> ---

Looks fine to me.

Reviewed-by: Joshua Crofts <joshua.crofts1@gmail.com>

-- 
Kind regards

CJD