linux-kernel - Re: [PATCH v7 02/14] media: doc: add document for rkisp1 meta buffer format

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <73414230-8e9a-a1f3-c121-fdd5b87cb5b2@collabora.com>
Date:   Thu, 4 Jul 2019 14:01:50 -0300
From:   André Almeida <andrealmeid@...labora.com>
To:     Helen Koike <helen.koike@...labora.com>,
        linux-rockchip@...ts.infradead.org
Cc:     devicetree@...r.kernel.org, eddie.cai.linux@...il.com,
        mchehab@...nel.org, heiko@...ech.de, jacob2.chen@...k-chips.com,
        jeffy.chen@...k-chips.com, zyc@...k-chips.com,
        linux-kernel@...r.kernel.org, tfiga@...omium.org,
        hans.verkuil@...co.com, laurent.pinchart@...asonboard.com,
        sakari.ailus@...ux.intel.com, kernel@...labora.com,
        ezequiel@...labora.com, linux-media@...r.kernel.org,
        linux-arm-kernel@...ts.infradead.org, zhengsq@...k-chips.com,
        Jacob Chen <jacob-chen@...k-chips.com>,
        Yong Zhi <yong.zhi@...el.com>,
        Guennadi Liakhovetski <g.liakhovetski@....de>
Subject: Re: [PATCH v7 02/14] media: doc: add document for rkisp1 meta buffer
 format

Hello Helen,

On 7/3/19 4:08 PM, Helen Koike wrote:
> From: Jacob Chen <jacob2.chen@...k-chips.com>
>
> This commit add document for rkisp1 meta buffer format
>
> Signed-off-by: Jacob Chen <jacob-chen@...k-chips.com>
> Acked-by: Hans Verkuil <hans.verkuil@...co.com>
> [update for upstream]
> Signed-off-by: Helen Koike <helen.koike@...labora.com>
>
> ---
>
> Changes in v7:
> - s/correspond/corresponding
> - s/use/uses
> - s/docuemnt/document
>
>  Documentation/media/uapi/v4l/meta-formats.rst |  2 ++
>  .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    | 20 +++++++++++++++++++
>  .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      | 18 +++++++++++++++++
>  3 files changed, 40 insertions(+)
>  create mode 100644 Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>  create mode 100644 Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>
> diff --git a/Documentation/media/uapi/v4l/meta-formats.rst b/Documentation/media/uapi/v4l/meta-formats.rst
> index b10ca9ee3968..5de621fea3cc 100644
> --- a/Documentation/media/uapi/v4l/meta-formats.rst
> +++ b/Documentation/media/uapi/v4l/meta-formats.rst
> @@ -24,3 +24,5 @@ These formats are used for the :ref:`metadata` interface only.
>      pixfmt-meta-uvc
>      pixfmt-meta-vsp1-hgo
>      pixfmt-meta-vsp1-hgt
> +    pixfmt-meta-rkisp1-params
> +    pixfmt-meta-rkisp1-stat
> diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> new file mode 100644
> index 000000000000..61b81331f820
> --- /dev/null
> +++ b/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> @@ -0,0 +1,20 @@
You can add a license information here, like this:
.. SPDX-License-Identifier: GPL-2.0
> +.. -*- coding: utf-8; mode: rst -*-
I believe it's not a good idea to include Emacs configuration in the
source [1].
> +
> +.. _v4l2-meta-fmt-rkisp1-params:
> +
> +*******************************
> +V4L2_META_FMT_RK_ISP1_PARAMS
> +*******************************
There's 3 extra `*`, keep the length of marks just as the length of the
text.
Also, for titles, you should use `=` [2] instead of `*`, like this:
=====
Title
=====
> +
> +Rockchip ISP1 Parameters Data
> +
> +Description
> +===========
> +
> +This format describes input parameters for the Rockchip ISP1.
> +
> +It uses c-struct :c:type:`rkisp1_isp_params_cfg`, which is defined in
> +the ``linux/rkisp1-config.h`` header file, see it for details.
Since the struct is already using kernel-doc syntax, you can including
in this file using something like this:
.. kernel-doc:: include/uapi/linux/rkisp1-config.h
   :functions: rkisp1_isp_params_cfg
> +
> +The parameters consist of multiple modules.
> +The module won't be updated if the corresponding bit was not set in module_*_update.
> diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> new file mode 100644
> index 000000000000..5496e1d42273
> --- /dev/null
> +++ b/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
The previous feedback also applies to this file.
> @@ -0,0 +1,18 @@
> +.. -*- coding: utf-8; mode: rst -*-
> +
> +.. _v4l2-meta-fmt-rkisp1-stat:
> +
> +*******************************
> +V4L2_META_FMT_RK_ISP1_STAT_3A
> +*******************************
> +
> +Rockchip ISP1 Statistics Data
> +
> +Description
> +===========
> +
> +This format describes image color statistics information generated by the Rockchip
> +ISP1.
> +
> +It uses c-struct :c:type:`rkisp1_stat_buffer`, which is defined in
> +the ``linux/cifisp_stat.h`` header file, see it for details.
Regards,
    André

[1]
https://www.kernel.org/doc/html/latest/process/coding-style.html#editor-modelines-and-other-cruft
[2]
https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html#specific-guidelines-for-the-kernel-documentation