diff mbox series

[16/15] ext-ctrls-codec.rst: update note at start of codec section

Message ID af1117cd-8bae-3b6d-41d9-876614425793@xs4all.nl
State New
Headers show
Series v4l2-controls.h: rename _MPEG_ to _CODEC_ | expand

Commit Message

Hans Verkuil March 14, 2021, 8:23 a.m. UTC
The note at the start of the Codec Control Reference section was
changed to explain the prefix naming change.

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
---
 .../userspace-api/media/v4l/ext-ctrls-codec.rst       | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
index 34884a785d76..528b97c989c7 100644
--- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
@@ -11,10 +11,13 @@  the generic controls, then controls specific for certain hardware.

 .. note::

-   These controls are applicable to all codecs and not just MPEG. The
-   defines are prefixed with V4L2_CID_MPEG/V4L2_MPEG as the controls
-   were originally made for MPEG codecs and later extended to cover all
-   encoding formats.
+   Originally these defines, enum names and struct names were prefixed with
+   V4L2_CID_MPEG/V4L2_MPEG/v4l2_mpeg instead of
+   V4L2_CID_CODEC/V4L2_CODEC/v4l2_codec as the codec controls were initially
+   made for just the MPEG codec and only later extended to cover more codecs.
+
+   The old names are still available to prevent breaking existing code and the
+   ``v4l2-controls.h`` header redefines them to the new names.


 Generic Codec Controls