From: "André Almeida" <andrealmeid@collabora.com>
To: Helen Koike <helen.koike@collabora.com>,
linux-rockchip@lists.infradead.org
Cc: devicetree@vger.kernel.org, eddie.cai.linux@gmail.com,
mchehab@kernel.org, heiko@sntech.de, jacob2.chen@rock-chips.com,
jeffy.chen@rock-chips.com, zyc@rock-chips.com,
linux-kernel@vger.kernel.org, tfiga@chromium.org,
hans.verkuil@cisco.com, laurent.pinchart@ideasonboard.com,
sakari.ailus@linux.intel.com, kernel@collabora.com,
ezequiel@collabora.com, linux-media@vger.kernel.org,
linux-arm-kernel@lists.infradead.org, zhengsq@rock-chips.com,
Jacob Chen <jacob-chen@rock-chips.com>,
Yong Zhi <yong.zhi@intel.com>,
Guennadi Liakhovetski <g.liakhovetski@gmx.de>
Subject: Re: [PATCH v7 02/14] media: doc: add document for rkisp1 meta buffer format
Date: Thu, 4 Jul 2019 14:01:50 -0300 [thread overview]
Message-ID: <73414230-8e9a-a1f3-c121-fdd5b87cb5b2@collabora.com> (raw)
In-Reply-To: <20190703190910.32633-3-helen.koike@collabora.com>
Hello Helen,
On 7/3/19 4:08 PM, Helen Koike wrote:
> From: Jacob Chen <jacob2.chen@rock-chips.com>
>
> This commit add document for rkisp1 meta buffer format
>
> Signed-off-by: Jacob Chen <jacob-chen@rock-chips.com>
> Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
> [update for upstream]
> Signed-off-by: Helen Koike <helen.koike@collabora.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
next prev parent reply other threads:[~2019-07-04 17:02 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20190703190910.32633-1-helen.koike@collabora.com>
2019-07-03 19:08 ` [PATCH v7 01/14] media: videodev2.h, v4l2-ioctl: add rkisp1 meta buffer format Helen Koike
2019-07-03 19:08 ` [PATCH v7 02/14] media: doc: add document for " Helen Koike
2019-07-04 17:01 ` André Almeida [this message]
2019-07-03 19:08 ` [PATCH v7 03/14] media: rkisp1: Add user space ABI definitions Helen Koike
2019-07-03 19:09 ` [PATCH v7 04/14] media: rkisp1: add Rockchip MIPI Synopsys DPHY driver Helen Koike
2019-07-03 19:59 ` Thomas Gleixner
2019-07-03 20:16 ` Helen Koike
2019-07-03 19:09 ` [PATCH v7 05/14] media: rkisp1: add Rockchip ISP1 subdev driver Helen Koike
2019-07-05 11:49 ` Dafna Hirschfeld
2019-07-03 19:09 ` [PATCH v7 06/14] media: rkisp1: add ISP1 statistics driver Helen Koike
2019-07-03 19:09 ` [PATCH v7 07/14] media: rkisp1: add ISP1 params driver Helen Koike
2019-07-03 19:09 ` [PATCH v7 08/14] media: rkisp1: add capture device driver Helen Koike
2019-07-04 17:27 ` André Almeida
2019-07-31 13:49 ` Helen Koike
2019-07-05 14:06 ` Dafna Hirschfeld
2019-07-03 19:09 ` [PATCH v7 09/14] media: rkisp1: add rockchip isp1 core driver Helen Koike
2019-07-03 19:09 ` [PATCH v7 10/14] dt-bindings: Document the Rockchip ISP1 bindings Helen Koike
2019-07-04 17:03 ` André Almeida
2019-07-03 19:09 ` [PATCH v7 11/14] dt-bindings: Document the Rockchip MIPI RX D-PHY bindings Helen Koike
2019-07-04 17:04 ` André Almeida
2019-07-03 19:09 ` [PATCH v7 12/14] arm64: dts: rockchip: add isp0 node for rk3399 Helen Koike
2019-07-03 19:09 ` [PATCH v7 13/14] arm64: dts: rockchip: add rx0 mipi-phy " Helen Koike
2019-07-03 19:09 ` [PATCH v7 14/14] MAINTAINERS: add entry for Rockchip ISP1 driver Helen Koike
2019-07-04 19:40 ` [PATCH v7 00/14] Rockchip ISP1 Driver Helen Koike
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=73414230-8e9a-a1f3-c121-fdd5b87cb5b2@collabora.com \
--to=andrealmeid@collabora.com \
--cc=devicetree@vger.kernel.org \
--cc=eddie.cai.linux@gmail.com \
--cc=ezequiel@collabora.com \
--cc=g.liakhovetski@gmx.de \
--cc=hans.verkuil@cisco.com \
--cc=heiko@sntech.de \
--cc=helen.koike@collabora.com \
--cc=jacob-chen@rock-chips.com \
--cc=jacob2.chen@rock-chips.com \
--cc=jeffy.chen@rock-chips.com \
--cc=kernel@collabora.com \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-rockchip@lists.infradead.org \
--cc=mchehab@kernel.org \
--cc=sakari.ailus@linux.intel.com \
--cc=tfiga@chromium.org \
--cc=yong.zhi@intel.com \
--cc=zhengsq@rock-chips.com \
--cc=zyc@rock-chips.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).