media: mc: entity: Fix minor issues in comments and documentation
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Mon, 12 Dec 2022 13:25:05 +0000 (14:25 +0100)
committerMauro Carvalho Chehab <mchehab@kernel.org>
Mon, 6 Feb 2023 07:37:12 +0000 (08:37 +0100)
Commit ae219872834a ("media: mc: entity: Rewrite
media_pipeline_start()") incorrectly referred to entity instead of pad
in a comment, and forgot to update a second comment accordingly when
moving the pipe from entity to pad. Furthermore, it didn't properly
reflow the documentation text it updated.

Fix those small issues.

Fixes: ae219872834a ("media: mc: entity: Rewrite media_pipeline_start()")
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Documentation/driver-api/media/mc-core.rst
drivers/media/mc/mc-entity.c

index 400b8ca29367e4391cca637bd418a9b7e0f0e0e4..2456950ce8ffb70ec1902665a095925268281d16 100644 (file)
@@ -232,12 +232,10 @@ prevent link states from being modified during streaming by calling
 
 The function will mark all the pads which are part of the pipeline as streaming.
 
-The struct media_pipeline instance pointed to by
-the pipe argument will be stored in every pad in the pipeline.
-Drivers should embed the struct media_pipeline
-in higher-level pipeline structures and can then access the
-pipeline through the struct media_pad
-pipe field.
+The struct media_pipeline instance pointed to by the pipe argument will be
+stored in every pad in the pipeline. Drivers should embed the struct
+media_pipeline in higher-level pipeline structures and can then access the
+pipeline through the struct media_pad pipe field.
 
 Calls to :c:func:`media_pipeline_start()` can be nested.
 The pipeline pointer must be identical for all nested calls to the function.
index 7c62d26d9797ad968268a219b9fb3ebf55348c2f..e7216a985ba6278525f855f0d6d78ce4cf8c6926 100644 (file)
@@ -724,8 +724,8 @@ __must_check int __media_pipeline_start(struct media_pad *pad,
        lockdep_assert_held(&mdev->graph_mutex);
 
        /*
-        * If the entity is already part of a pipeline, that pipeline must
-        * be the same as the pipe given to media_pipeline_start().
+        * If the pad is already part of a pipeline, that pipeline must be the
+        * same as the pipe given to media_pipeline_start().
         */
        if (WARN_ON(pad->pipe && pad->pipe != pipe))
                return -EINVAL;
@@ -919,7 +919,7 @@ __must_check int media_pipeline_alloc_start(struct media_pad *pad)
        mutex_lock(&mdev->graph_mutex);
 
        /*
-        * Is the entity already part of a pipeline? If not, we need to allocate
+        * Is the pad already part of a pipeline? If not, we need to allocate
         * a pipe.
         */
        pipe = media_pad_pipeline(pad);