All of lore.kernel.org
 help / color / mirror / Atom feed
From: Sakari Ailus <sakari.ailus@linux.intel.com>
To: linux-media@vger.kernel.org
Cc: laurent.pinchart@ideasonboard.com, hverkuil@xs4all.nl
Subject: [PATCH v3 1/5] mc: Remove redundant documentation
Date: Wed,  9 Mar 2022 18:31:08 +0200	[thread overview]
Message-ID: <20220309163112.11708-2-sakari.ailus@linux.intel.com> (raw)
In-Reply-To: <20220309163112.11708-1-sakari.ailus@linux.intel.com>

Remove redundant kerneldoc documentation in mc-device.c. The functions are
already documented in media-device.h, where non-redundant documentation is
also moved.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 drivers/media/mc/mc-device.c | 15 ---------------
 include/media/media-device.h |  6 ++++++
 2 files changed, 6 insertions(+), 15 deletions(-)

diff --git a/drivers/media/mc/mc-device.c b/drivers/media/mc/mc-device.c
index cf5e459b1d96..094647fdb866 100644
--- a/drivers/media/mc/mc-device.c
+++ b/drivers/media/mc/mc-device.c
@@ -608,11 +608,6 @@ static void __media_device_unregister_entity(struct media_entity *entity)
 	entity->graph_obj.mdev = NULL;
 }
 
-/**
- * media_device_register_entity - Register an entity with a media device
- * @mdev:	The media device
- * @entity:	The entity
- */
 int __must_check media_device_register_entity(struct media_device *mdev,
 					      struct media_entity *entity)
 {
@@ -691,16 +686,6 @@ void media_device_unregister_entity(struct media_entity *entity)
 }
 EXPORT_SYMBOL_GPL(media_device_unregister_entity);
 
-/**
- * media_device_init() - initialize a media device
- * @mdev:	The media device
- *
- * The caller is responsible for initializing the media device before
- * registration. The following fields must be set:
- *
- * - dev must point to the parent device
- * - model must be filled with the device model name
- */
 void media_device_init(struct media_device *mdev)
 {
 	INIT_LIST_HEAD(&mdev->entities);
diff --git a/include/media/media-device.h b/include/media/media-device.h
index 1345e6da688a..7d5b212792a5 100644
--- a/include/media/media-device.h
+++ b/include/media/media-device.h
@@ -219,6 +219,12 @@ static inline __must_check int media_entity_enum_init(
  * So drivers need to first initialize the media device, register any entity
  * within the media device, create pad to pad links and then finally register
  * the media device by calling media_device_register() as a final step.
+ *
+ * The caller is responsible for initializing the media device before
+ * registration. The following fields must be set:
+ *
+ * - dev must point to the parent device
+ * - model must be filled with the device model name
  */
 void media_device_init(struct media_device *mdev);
 
-- 
2.30.2


  reply	other threads:[~2022-03-09 16:43 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-09 16:31 [PATCH v3 0/5] Set bus_info field in framework Sakari Ailus
2022-03-09 16:31 ` Sakari Ailus [this message]
2022-03-09 16:31 ` [PATCH v3 2/5] mc: media_device_init() initialises a media_device, not media_entity Sakari Ailus
2022-03-16  9:15   ` Laurent Pinchart
2022-03-09 16:31 ` [PATCH v3 3/5] mc: Provide a helper for setting bus_info field Sakari Ailus
2022-03-16  9:18   ` Laurent Pinchart
2022-03-16  9:24     ` Laurent Pinchart
2022-03-16  9:50       ` Sakari Ailus
2022-03-09 16:31 ` [PATCH v3 4/5] mc: Set bus_info in media_device_init() Sakari Ailus
2022-03-16  9:22   ` Laurent Pinchart
2022-03-09 16:31 ` [PATCH v3 5/5] v4l: ioctl: Set bus_info in v4l_querycap() Sakari Ailus
2022-04-14 11:07   ` [PATCH v4 " Sakari Ailus

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220309163112.11708-2-sakari.ailus@linux.intel.com \
    --to=sakari.ailus@linux.intel.com \
    --cc=hverkuil@xs4all.nl \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-media@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.