Em Thu, 28 Jun 2018 15:12:00 +0200
Hans Verkuil <hverkuil@xxxxxxxxx> escreveu:
> From: Hans Verkuil <hans.verkuil@xxxxxxxxx>
>
> Document the new struct media_v2_pad 'index' field.
>
> Signed-off-by: Hans Verkuil <hans.verkuil@xxxxxxxxx>
> Acked-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>
> ---
> .../media/uapi/mediactl/media-ioc-g-topology.rst | 11 +++++++++--
> 1 file changed, 9 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst b/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
> index a3f259f83b25..24ab34b22df2 100644
> --- a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
> +++ b/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
> @@ -176,7 +176,7 @@ desired arrays with the media graph elements.
> * - struct media_v2_intf_devnode
> - ``devnode``
> - Used only for device node interfaces. See
> - :c:type:`media_v2_intf_devnode` for details..
> + :c:type:`media_v2_intf_devnode` for details.
>
>
> .. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}|
> @@ -218,7 +218,14 @@ desired arrays with the media graph elements.
> - Pad flags, see :ref:`media-pad-flag` for more details.
>
> * - __u32
> - - ``reserved``\ [5]
> + - ``index``
> + - 0-based pad index. Only valid if ``MEDIA_V2_PAD_HAS_INDEX(media_version)``
> + returns true. The ``media_version`` is defined in struct
> + :c:type:`media_device_info` and can be retrieved using
> + :ref:`MEDIA_IOC_DEVICE_INFO`.
"0-based pad index"...
what you mean by that? If what you want to say is that it starts
with zero, I would use a clearer text, like:
"Pad index, starting from zero."
It is probably worth saying that the pad index could vary on newer
versions of the Kernel.
> +
> + * - __u32
> + - ``reserved``\ [4]
> - Reserved for future extensions. Drivers and applications must set
> this array to zero.
>
Thanks,
Mauro
