[4/4] media: docs: Depricate mfc frame skip control

Message ID 20200705121128.5250-5-stanimir.varbanov@linaro.org
State New
Headers show
Series
  • Make Frame Skip Mode control a standard
Related show

Commit Message

Stanimir Varbanov July 5, 2020, 12:11 p.m.
Depricate mfc private frame skip mode control for new
clients and use the standard one instead.

Signed-off-by: Stanimir Varbanov <stanimir.varbanov@linaro.org>

---
 Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst | 5 +++++
 1 file changed, 5 insertions(+)

-- 
2.17.1

Comments

Randy Dunlap July 5, 2020, 3:29 p.m. | #1
On 7/5/20 5:11 AM, Stanimir Varbanov wrote:
> Depricate mfc private frame skip mode control for new


  Deprecate

Also in $subject.

> clients and use the standard one instead.

> 

> Signed-off-by: Stanimir Varbanov <stanimir.varbanov@linaro.org>

> ---

>  Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst | 5 +++++

>  1 file changed, 5 insertions(+)

> 

> diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst

> index a8b4c0b40747..c0760bfc54d4 100644

> --- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst

> +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst

> @@ -2805,6 +2805,11 @@ MFC 5.1 Control IDs

>  ``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE``

>      (enum)

>  

> +    .. note::

> +

> +       This control is depricated. Use the standard one


                          deprecated.


> +       ``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE`` instead.

> +

>  enum v4l2_mpeg_mfc51_video_frame_skip_mode -

>      Indicates in what conditions the encoder should skip frames. If

>      encoding a frame would cause the encoded stream to be larger then a

> 



-- 
~Randy
Hans Verkuil July 20, 2020, 9:33 a.m. | #2
On 05/07/2020 14:11, Stanimir Varbanov wrote:
> Depricate mfc private frame skip mode control for new


Depricate -> Deprecate (same in the patch below).

> clients and use the standard one instead.

> 

> Signed-off-by: Stanimir Varbanov <stanimir.varbanov@linaro.org>

> ---

>  Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst | 5 +++++

>  1 file changed, 5 insertions(+)

> 

> diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst

> index a8b4c0b40747..c0760bfc54d4 100644

> --- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst

> +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst

> @@ -2805,6 +2805,11 @@ MFC 5.1 Control IDs

>  ``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE``

>      (enum)

>  

> +    .. note::

> +

> +       This control is depricated. Use the standard one


s/one//

> +       ``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE`` instead.


s/instead/control instead/

> +

>  enum v4l2_mpeg_mfc51_video_frame_skip_mode -

>      Indicates in what conditions the encoder should skip frames. If

>      encoding a frame would cause the encoded stream to be larger then a

>

Patch

diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
index a8b4c0b40747..c0760bfc54d4 100644
--- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
@@ -2805,6 +2805,11 @@  MFC 5.1 Control IDs
 ``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE``
     (enum)
 
+    .. note::
+
+       This control is depricated. Use the standard one
+       ``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE`` instead.
+
 enum v4l2_mpeg_mfc51_video_frame_skip_mode -
     Indicates in what conditions the encoder should skip frames. If
     encoding a frame would cause the encoded stream to be larger then a