2020-08-12 17:49:55

by Puranjay Mohan

Subject: [PATCH] IIO: Documentation: Replace deprecated :c:func: Usage

Replace :c:func: with func() as the previous usage is deprecated.

Signed-off-by: Puranjay Mohan <[email protected]>
---
Documentation/driver-api/iio/core.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/driver-api/iio/core.rst b/Documentation/driver-api/iio/core.rst
index b0bc0c028cc5..51b21e002396 100644
--- a/Documentation/driver-api/iio/core.rst
+++ b/Documentation/driver-api/iio/core.rst
@@ -11,10 +11,10 @@ Industrial I/O Devices
----------------------

* struct :c:type:`iio_dev` - industrial I/O device
-* :c:func:`iio_device_alloc()` - allocate an :c:type:`iio_dev` from a driver
-* :c:func:`iio_device_free()` - free an :c:type:`iio_dev` from a driver
-* :c:func:`iio_device_register()` - register a device with the IIO subsystem
-* :c:func:`iio_device_unregister()` - unregister a device from the IIO
+* iio_device_alloc() - allocate an :c:type:`iio_dev` from a driver
+* iio_device_free() - free an :c:type:`iio_dev` from a driver
+* iio_device_register() - register a device with the IIO subsystem
+* iio_device_unregister() - unregister a device from the IIO
subsystem

An IIO device usually corresponds to a single hardware sensor and it
@@ -34,17 +34,17 @@ A typical IIO driver will register itself as an :doc:`I2C <../i2c>` or

At probe:

-1. Call :c:func:`iio_device_alloc()`, which allocates memory for an IIO device.
+1. Call iio_device_alloc(), which allocates memory for an IIO device.
2. Initialize IIO device fields with driver specific information (e.g.
device name, device channels).
-3. Call :c:func:`iio_device_register()`, this registers the device with the
+3. Call iio_device_register(), this registers the device with the
IIO core. After this call the device is ready to accept requests from user
space applications.

At remove, we free the resources allocated in probe in reverse order:

-1. :c:func:`iio_device_unregister()`, unregister the device from the IIO core.
-2. :c:func:`iio_device_free()`, free the memory allocated for the IIO device.
+1. iio_device_unregister(), unregister the device from the IIO core.
+2. iio_device_free(), free the memory allocated for the IIO device.

IIO device sysfs interface
==========================
--
2.27.0

2020-08-24 22:03:19

by Jonathan Corbet

Subject: Re: [PATCH] IIO: Documentation: Replace deprecated :c:func: Usage

On Wed, 12 Aug 2020 23:16:11 +0530
Puranjay Mohan <[email protected]> wrote:

> Replace :c:func: with func() as the previous usage is deprecated.
>
> Signed-off-by: Puranjay Mohan <[email protected]>
> ---
> Documentation/driver-api/iio/core.rst | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)

Applied, thanks.

jon