Re: [PATCHv3 1/5] media: docs-rst: Document memory-to-memory video encoder interface

[Mauro Carvalho Chehab <mchehab+huawei@kernel.org>]

Em Tue, 26 May 2020 12:09:28 +0200
Hans Verkuil <hverkuil-cisco@xs4all.nl> escreveu:

There are some things here that it should be fine for now, but I would like
to be added on our TODO:

> +Conventions and Notations Used in This Document
> +===============================================

...

> +
> +2. The meaning of words "must", "may", "should", etc. is as per `RFC
> +   2119 <https://tools.ietf.org/html/rfc2119>`_.
> +
> +3. All steps not marked "optional" are required.

Those should be moved in the future to the media uAPI spec as a hole.

> +
> +4. :c:func:`VIDIOC_G_EXT_CTRLS` and :c:func:`VIDIOC_S_EXT_CTRLS` may be used
> +   interchangeably with :c:func:`VIDIOC_G_CTRL` and :c:func:`VIDIOC_S_CTRL`,
> +   unless specified otherwise.
> +
> +5. Single-planar API (see :ref:`planar-apis`) and applicable structures may be
> +   used interchangeably with multi-planar API, unless specified otherwise,
> +   depending on encoder capabilities and following the general V4L2 guidelines.

Probably those too.

> +Glossary
> +========
> +
> +Refer to :ref:`decoder-glossary`.

I have some patches (yet to be merged) for a media glossary. We should move
the decoder one to be at the same place.

Thanks,
Mauro