Re: [PATCH v4 2/5] docs: Document colorimetry class

From: Hans Verkuil
Date: Tue Jan 26 2021 - 00:31:19 EST


On 20/01/2021 10:26, Stanimir Varbanov wrote:
> Add a document for ext control colorimetry class.
>
> Signed-off-by: Stanimir Varbanov <stanimir.varbanov@xxxxxxxxxx>
> ---
> .../userspace-api/media/v4l/common.rst | 1 +
> .../media/v4l/ext-ctrls-colorimetry.rst | 19 +++++++++++++++++++
> .../media/v4l/vidioc-g-ext-ctrls.rst | 4 ++++
> 3 files changed, 24 insertions(+)
> create mode 100644 Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst
>
> diff --git a/Documentation/userspace-api/media/v4l/common.rst b/Documentation/userspace-api/media/v4l/common.rst
> index 8c263c5a85d8..ea0435182e44 100644
> --- a/Documentation/userspace-api/media/v4l/common.rst
> +++ b/Documentation/userspace-api/media/v4l/common.rst
> @@ -51,6 +51,7 @@ applicable to all devices.
> ext-ctrls-fm-tx
> ext-ctrls-fm-rx
> ext-ctrls-detect
> + ext-ctrls-colorimetry
> fourcc
> format
> planar-apis
> diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst
> new file mode 100644
> index 000000000000..6b0cd2054e84
> --- /dev/null
> +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst
> @@ -0,0 +1,19 @@
> +.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
> +
> +.. _colorimetry-controls:
> +
> +*****************************
> +Colorimetry Control Reference
> +*****************************
> +
> +Below are controls within the Colorimetry control class.

This needs a bit more work since it doesn't explain anything :-)

See how it is done in other ext-ctrls-*.rst files.

Regards,

Hans

> +
> +Colorimetry Control IDs
> +-----------------------
> +
> +.. _colorimetry-control-id:
> +
> +``V4L2_CID_COLORIMETRY_CLASS (class)``
> + The Colorimetry class descriptor. Calling
> + :ref:`VIDIOC_QUERYCTRL` for this control will
> + return a description of this control class.
> diff --git a/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst
> index b9c62affbb5a..8a95ebdd499a 100644
> --- a/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst
> +++ b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst
> @@ -394,6 +394,10 @@ still cause this situation.
> - 0xa40000
> - The class containing stateless codec controls. These controls are
> described in :ref:`codec-stateless-controls`.
> + * - ``V4L2_CTRL_CLASS_COLORIMETRY``
> + - 0xa50000
> + - The class containing colorimetry controls. These controls are
> + described in :ref:`colorimetry-controls`.
>
> Return Value
> ============
>