Skip to contentSkip to conversation

media: docs: Document metadata format in struct v4l2_format

PATCH In review Sakari Ailus 2 participants 3 messages Oct 9, 2018

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 media: docs: Document metadata format in struct v4l2_format

The format fields in struct v4l2_format were otherwise reported but the meta field was missing. Document it.

---
 Documentation/media/uapi/v4l/dev-meta.rst     | 2 +-
 Documentation/media/uapi/v4l/vidioc-g-fmt.rst | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)
Documentation/media/uapi/v4l/dev-meta.rst +1 -1
index f7ac8d0d3af14..b65dc078abeb8 100644
@@ -40,7 +40,7 @@ To use the :ref:`format` ioctls applications set the ``type`` field of the
 the desired operation. Both drivers and applications must set the remainder of
 the :c:type:`v4l2_format` structure to 0.
 
-.. _v4l2-meta-format:
+.. c:type:: v4l2_meta_format
 
 .. tabularcolumns:: |p{1.4cm}|p{2.2cm}|p{13.9cm}|
 
Documentation/media/uapi/v4l/vidioc-g-fmt.rst +5 -0
index 3ead350e099f9..9ea494a8facab 100644
@@ -133,6 +133,11 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
       - Definition of a data format, see :ref:`pixfmt`, used by SDR
 	capture and output devices.
     * -
+      - struct :c:type:`v4l2_meta_format`
+      - ``meta``
+      - Definition of a metadata format, see :ref:`meta-formats`, used by
+	metadata capture devices.
+    * -
       - __u8
       - ``raw_data``\ [200]
       - Place holder for future extensions.
Signature · 1 line
2.11.0
Acked-by on v1 1/1
#1 lore raw
Quoted 5 lines · Sakari Ailus

The format fields in struct v4l2_format were otherwise reported but the meta field was missing. Document it.

Thanks!

Hans

Quoted 35 lines
---
 Documentation/media/uapi/v4l/dev-meta.rst     | 2 +-
 Documentation/media/uapi/v4l/vidioc-g-fmt.rst | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)
Documentation/media/uapi/v4l/dev-meta.rst +1 -1
index f7ac8d0d3af14..b65dc078abeb8 100644
@@ -40,7 +40,7 @@ To use the :ref:`format` ioctls applications set the ``type`` field of the
 the desired operation. Both drivers and applications must set the remainder of
 the :c:type:`v4l2_format` structure to 0.
 
-.. _v4l2-meta-format:
+.. c:type:: v4l2_meta_format
 
 .. tabularcolumns:: |p{1.4cm}|p{2.2cm}|p{13.9cm}|
 
Documentation/media/uapi/v4l/vidioc-g-fmt.rst +5 -0
index 3ead350e099f9..9ea494a8facab 100644
@@ -133,6 +133,11 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
       - Definition of a data format, see :ref:`pixfmt`, used by SDR
 	capture and output devices.
     * -
+      - struct :c:type:`v4l2_meta_format`
+      - ``meta``
+      - Definition of a metadata format, see :ref:`meta-formats`, used by
+	metadata capture devices.
+    * -
       - __u8
       - ``raw_data``\ [200]
       - Place holder for future extensions.
#2 lore raw
Quoted 10 lines · Hans Verkuil
Quoted 5 lines · Sakari Ailus

The format fields in struct v4l2_format were otherwise reported but the meta field was missing. Document it.

Thanks!

Thanks!

I'll replace "reported" in the commit message by "documented" for the pull request.

Signature · 2 lines
Sakari Ailus
[email protected]