diff mbox series

[1/1] media: v4l2: Fix v4l2_i2c_subdev_set_name function documentation

Message ID 20220722071131.2022212-1-alexander.stein@ew.tq-group.com
State Accepted
Commit bb9ea2c31fa11b789ade4c3abcdda3c5370a76ab
Headers show
Series [1/1] media: v4l2: Fix v4l2_i2c_subdev_set_name function documentation | expand

Commit Message

Alexander Stein July 22, 2022, 7:11 a.m. UTC
The doc says the I²C device's name is used if devname is NULL, but
actually the I²C device driver's name is used.

Fixes commit 0658293012af ("media: v4l: subdev: Add a function to set an I²C sub-device's name")
Signed-off-by: Alexander Stein <alexander.stein@ew.tq-group.com>
---
Apparently you can't provide a proper device name in ACPI (see [1]), so
using the driver's name is reasonable. Adjust function documentation
accordingly.

[1] https://lore.kernel.org/all/YtpDp3ahpabQ1ubY@paasikivi.fi.intel.com/

 include/media/v4l2-common.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/media/v4l2-common.h b/include/media/v4l2-common.h
index b708d63995f4..2ae2be4c87e5 100644
--- a/include/media/v4l2-common.h
+++ b/include/media/v4l2-common.h
@@ -175,7 +175,8 @@  struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
  *
  * @sd: pointer to &struct v4l2_subdev
  * @client: pointer to struct i2c_client
- * @devname: the name of the device; if NULL, the I²C device's name will be used
+ * @devname: the name of the device; if NULL, the I²C device drivers's name
+ *           will be used
  * @postfix: sub-device specific string to put right after the I²C device name;
  *	     may be NULL
  */