diff mbox series

[v4,2/3] media: Documentation/driver-api: Document device name

Message ID 20220920-resend-meta-v4-2-3ac355b66723@chromium.org
State New
Headers
Series Add Meta: to Metadata devices |

Commit Message

Ricardo Ribalda Dec. 2, 2022, 5:08 p.m. UTC 
  Document how the name of the metadata devices is modified.

Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
 Documentation/driver-api/media/v4l2-dev.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Yunke Cao Dec. 5, 2022, 5:06 a.m. UTC | #1 
On Sat, Dec 3, 2022 at 2:08 AM Ricardo Ribalda <ribalda@chromium.org> wrote:
>
> Document how the name of the metadata devices is modified.
>
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> ---
>  Documentation/driver-api/media/v4l2-dev.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/media/v4l2-dev.rst b/Documentation/driver-api/media/v4l2-dev.rst
> index 99e3b5fa7444..935a46e29c5e 100644
> --- a/Documentation/driver-api/media/v4l2-dev.rst
> +++ b/Documentation/driver-api/media/v4l2-dev.rst
> @@ -42,7 +42,9 @@ You should also set these fields of :c:type:`video_device`:
>  - :c:type:`video_device`->v4l2_dev: must be set to the :c:type:`v4l2_device`
>    parent device.
>
> -- :c:type:`video_device`->name: set to something descriptive and unique.
> +- :c:type:`video_device`->name: set to something descriptive and unique. If the
> +  device has the `V4L2_CAP_META_CAPTURE` or `V4L2_CAP_META_OUTPUT` capabilities,
> +  the string `Meta:` will be inserted before the original name.
>
>  - :c:type:`video_device`->vfl_dir: set this to ``VFL_DIR_RX`` for capture
>    devices (``VFL_DIR_RX`` has value 0, so this is normally already the
>
> --
> 2.39.0.rc0.267.gcb52ba06e7-goog-b4-0.11.0-dev-696ae
Reviewed-by: Yunke Cao <yunkec@chromium.org>
diff mbox series

Patch

diff --git a/Documentation/driver-api/media/v4l2-dev.rst b/Documentation/driver-api/media/v4l2-dev.rst
index 99e3b5fa7444..935a46e29c5e 100644
--- a/Documentation/driver-api/media/v4l2-dev.rst
+++ b/Documentation/driver-api/media/v4l2-dev.rst
@@ -42,7 +42,9 @@  You should also set these fields of :c:type:`video_device`:
 - :c:type:`video_device`->v4l2_dev: must be set to the :c:type:`v4l2_device`
   parent device.
 
-- :c:type:`video_device`->name: set to something descriptive and unique.
+- :c:type:`video_device`->name: set to something descriptive and unique. If the
+  device has the `V4L2_CAP_META_CAPTURE` or `V4L2_CAP_META_OUTPUT` capabilities,
+  the string `Meta:` will be inserted before the original name.
 
 - :c:type:`video_device`->vfl_dir: set this to ``VFL_DIR_RX`` for capture
   devices (``VFL_DIR_RX`` has value 0, so this is normally already the