diff mbox series

[v11,02/11] media: staging: rkisp1: add document for rkisp1 meta buffer format

Message ID 20191114051242.14651-3-helen.koike@collabora.com (mailing list archive)
State New, archived
Headers show
Series Rockchip ISP Driver | expand

Commit Message

Helen Mae Koike Fornazier Nov. 14, 2019, 5:12 a.m. UTC
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>
[refactored for upstream]
Signed-off-by: Helen Koike <helen.koike@collabora.com>

---

Changes in v11: None
Changes in v10:
- unsquash

Changes in v9:
- squash
- migrate to staging
- remove meta-formats.rst update

Changes in v8:
- Add SPDX in the header
- Remove emacs configs
- Fix doc style

Changes in v7:
- s/correspond/corresponding
- s/use/uses
- s/docuemnt/document

 .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    | 23 +++++++++++++++++++
 .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      | 22 ++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
 create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst

Comments

Hans Verkuil Nov. 14, 2019, 8:21 a.m. UTC | #1
On 11/14/19 6:12 AM, 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>
> [refactored for upstream]
> Signed-off-by: Helen Koike <helen.koike@collabora.com>

checkpatch gives me:

WARNING: Missing Signed-off-by: line by nominal patch author 'Jacob Chen <jacob2.chen@rock-chips.com>'

Looking at this series I see duplicate Signed-off-by entries for Jacob Chen and a total
of three different email addresses:

jacob2.chen@rock-chips.com
jacob-chen@rock-chips.com
cc@rock-chips.com

It's confusing.

Regards,

	Hans

> 
> ---
> 
> Changes in v11: None
> Changes in v10:
> - unsquash
> 
> Changes in v9:
> - squash
> - migrate to staging
> - remove meta-formats.rst update
> 
> Changes in v8:
> - Add SPDX in the header
> - Remove emacs configs
> - Fix doc style
> 
> Changes in v7:
> - s/correspond/corresponding
> - s/use/uses
> - s/docuemnt/document
> 
>  .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    | 23 +++++++++++++++++++
>  .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      | 22 ++++++++++++++++++
>  2 files changed, 45 insertions(+)
>  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> 
> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> new file mode 100644
> index 000000000000..103b5cb79b7c
> --- /dev/null
> +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> @@ -0,0 +1,23 @@
> +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> +
> +.. _v4l2-meta-fmt-rkisp1-params:
> +
> +============================
> +V4L2_META_FMT_RK_ISP1_PARAMS
> +============================
> +
> +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.
> +
> +The parameters consist of multiple modules.
> +The module won't be updated if the corresponding bit was not set in module_*_update.
> +
> +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> +   :functions: rkisp1_isp_params_cfg
> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> new file mode 100644
> index 000000000000..4ad303f96421
> --- /dev/null
> +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> @@ -0,0 +1,22 @@
> +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> +
> +.. _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/rkisp1-config.h`` header file.
> +
> +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> +   :functions: rkisp1_stat_buffer
>
Tomasz Figa Nov. 14, 2019, 8:47 a.m. UTC | #2
On Thu, Nov 14, 2019 at 5:21 PM Hans Verkuil <hverkuil@xs4all.nl> wrote:
>
> On 11/14/19 6:12 AM, 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>
> > [refactored for upstream]
> > Signed-off-by: Helen Koike <helen.koike@collabora.com>
>
> checkpatch gives me:
>
> WARNING: Missing Signed-off-by: line by nominal patch author 'Jacob Chen <jacob2.chen@rock-chips.com>'
>
> Looking at this series I see duplicate Signed-off-by entries for Jacob Chen and a total
> of three different email addresses:
>
> jacob2.chen@rock-chips.com
> jacob-chen@rock-chips.com
> cc@rock-chips.com

I remember there used to be two different people named Jacob Chen in
the project. Also FWIW at least one of them
(jacob2.chen@rock-chips.com) is not at Rockchip anymore.

Looking in my inbox, I don't see anyone matching
jacob-chen@rock-chips.com, so that could possibly be a mistyped
jacob2.chen@rock-chips.com?

Best regards,
Tomasz



>
> It's confusing.
>
> Regards,
>
>         Hans
>
> >
> > ---
> >
> > Changes in v11: None
> > Changes in v10:
> > - unsquash
> >
> > Changes in v9:
> > - squash
> > - migrate to staging
> > - remove meta-formats.rst update
> >
> > Changes in v8:
> > - Add SPDX in the header
> > - Remove emacs configs
> > - Fix doc style
> >
> > Changes in v7:
> > - s/correspond/corresponding
> > - s/use/uses
> > - s/docuemnt/document
> >
> >  .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    | 23 +++++++++++++++++++
> >  .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      | 22 ++++++++++++++++++
> >  2 files changed, 45 insertions(+)
> >  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> >  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> >
> > diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> > new file mode 100644
> > index 000000000000..103b5cb79b7c
> > --- /dev/null
> > +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> > @@ -0,0 +1,23 @@
> > +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> > +
> > +.. _v4l2-meta-fmt-rkisp1-params:
> > +
> > +============================
> > +V4L2_META_FMT_RK_ISP1_PARAMS
> > +============================
> > +
> > +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.
> > +
> > +The parameters consist of multiple modules.
> > +The module won't be updated if the corresponding bit was not set in module_*_update.
> > +
> > +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> > +   :functions: rkisp1_isp_params_cfg
> > diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> > new file mode 100644
> > index 000000000000..4ad303f96421
> > --- /dev/null
> > +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> > @@ -0,0 +1,22 @@
> > +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> > +
> > +.. _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/rkisp1-config.h`` header file.
> > +
> > +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> > +   :functions: rkisp1_stat_buffer
> >
>
Helen Mae Koike Fornazier Nov. 14, 2019, 10:58 a.m. UTC | #3
On 11/14/19 6:21 AM, Hans Verkuil wrote:
> On 11/14/19 6:12 AM, 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>
>> [refactored for upstream]
>> Signed-off-by: Helen Koike <helen.koike@collabora.com>
> 
> checkpatch gives me:
> 
> WARNING: Missing Signed-off-by: line by nominal patch author 'Jacob Chen <jacob2.chen@rock-chips.com>'
> 
> Looking at this series I see duplicate Signed-off-by entries for Jacob Chen and a total
> of three different email addresses:
> 
> jacob2.chen@rock-chips.com
> jacob-chen@rock-chips.com
> cc@rock-chips.com

And I see a name in the Maintainers file as Jacob Chen <jacob-chen@iotwrt.com>.
I was wondering if I could replace the email by jacob-chen@iotwrt.com, or if I should
keep the original ones.

Helen

> 
> It's confusing.
> 
> Regards,
> 
> 	Hans
> 
>>
>> ---
>>
>> Changes in v11: None
>> Changes in v10:
>> - unsquash
>>
>> Changes in v9:
>> - squash
>> - migrate to staging
>> - remove meta-formats.rst update
>>
>> Changes in v8:
>> - Add SPDX in the header
>> - Remove emacs configs
>> - Fix doc style
>>
>> Changes in v7:
>> - s/correspond/corresponding
>> - s/use/uses
>> - s/docuemnt/document
>>
>>  .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    | 23 +++++++++++++++++++
>>  .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      | 22 ++++++++++++++++++
>>  2 files changed, 45 insertions(+)
>>  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>>  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>>
>> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>> new file mode 100644
>> index 000000000000..103b5cb79b7c
>> --- /dev/null
>> +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>> @@ -0,0 +1,23 @@
>> +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
>> +
>> +.. _v4l2-meta-fmt-rkisp1-params:
>> +
>> +============================
>> +V4L2_META_FMT_RK_ISP1_PARAMS
>> +============================
>> +
>> +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.
>> +
>> +The parameters consist of multiple modules.
>> +The module won't be updated if the corresponding bit was not set in module_*_update.
>> +
>> +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
>> +   :functions: rkisp1_isp_params_cfg
>> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>> new file mode 100644
>> index 000000000000..4ad303f96421
>> --- /dev/null
>> +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>> @@ -0,0 +1,22 @@
>> +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
>> +
>> +.. _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/rkisp1-config.h`` header file.
>> +
>> +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
>> +   :functions: rkisp1_stat_buffer
>>
>
Jacob Chen Nov. 19, 2019, 10:16 a.m. UTC | #4
Hi Helen ,

Helen Koike <helen.koike@collabora.com> 于2019年11月14日周四 下午6:59写道:
>
>
>
> On 11/14/19 6:21 AM, Hans Verkuil wrote:
> > On 11/14/19 6:12 AM, 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>
> >> [refactored for upstream]
> >> Signed-off-by: Helen Koike <helen.koike@collabora.com>
> >
> > checkpatch gives me:
> >
> > WARNING: Missing Signed-off-by: line by nominal patch author 'Jacob Chen <jacob2.chen@rock-chips.com>'
> >
> > Looking at this series I see duplicate Signed-off-by entries for Jacob Chen and a total
> > of three different email addresses:
> >
> > jacob2.chen@rock-chips.com
> > jacob-chen@rock-chips.com
> > cc@rock-chips.com
>
> And I see a name in the Maintainers file as Jacob Chen <jacob-chen@iotwrt.com>.
> I was wondering if I could replace the email by jacob-chen@iotwrt.com, or if I should
> keep the original ones.
>
> Helen
>

"jacob2.chen@rock-chips.com"/"jacob-chen@rock-chips.com" is me and
"cc@rock-chips.com" is another one.
' jacob-chen@rock-chips.com' is invalid now,  so you could replace the
email by 'jacob-chen@iotwrt.com'.

> >
> > It's confusing.
> >
> > Regards,
> >
> >       Hans
> >
> >>
> >> ---
> >>
> >> Changes in v11: None
> >> Changes in v10:
> >> - unsquash
> >>
> >> Changes in v9:
> >> - squash
> >> - migrate to staging
> >> - remove meta-formats.rst update
> >>
> >> Changes in v8:
> >> - Add SPDX in the header
> >> - Remove emacs configs
> >> - Fix doc style
> >>
> >> Changes in v7:
> >> - s/correspond/corresponding
> >> - s/use/uses
> >> - s/docuemnt/document
> >>
> >>  .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    | 23 +++++++++++++++++++
> >>  .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      | 22 ++++++++++++++++++
> >>  2 files changed, 45 insertions(+)
> >>  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> >>  create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> >>
> >> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> >> new file mode 100644
> >> index 000000000000..103b5cb79b7c
> >> --- /dev/null
> >> +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> >> @@ -0,0 +1,23 @@
> >> +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> >> +
> >> +.. _v4l2-meta-fmt-rkisp1-params:
> >> +
> >> +============================
> >> +V4L2_META_FMT_RK_ISP1_PARAMS
> >> +============================
> >> +
> >> +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.
> >> +
> >> +The parameters consist of multiple modules.
> >> +The module won't be updated if the corresponding bit was not set in module_*_update.
> >> +
> >> +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> >> +   :functions: rkisp1_isp_params_cfg
> >> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> >> new file mode 100644
> >> index 000000000000..4ad303f96421
> >> --- /dev/null
> >> +++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> >> @@ -0,0 +1,22 @@
> >> +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> >> +
> >> +.. _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/rkisp1-config.h`` header file.
> >> +
> >> +.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> >> +   :functions: rkisp1_stat_buffer
> >>
> >
>
> _______________________________________________
> Linux-rockchip mailing list
> Linux-rockchip@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-rockchip
Ezequiel Garcia Nov. 19, 2019, 12:55 p.m. UTC | #5
Hello Jacob,

Thanks for the insight.

On Tue, 2019-11-19 at 18:16 +0800, Jacob Chen wrote:
> Hi Helen ,
> 
> Helen Koike <helen.koike@collabora.com> 于2019年11月14日周四 下午6:59写道:
> > 
> > 
> > On 11/14/19 6:21 AM, Hans Verkuil wrote:
> > > On 11/14/19 6:12 AM, 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>
> > > > [refactored for upstream]
> > > > Signed-off-by: Helen Koike <helen.koike@collabora.com>
> > > 
> > > checkpatch gives me:
> > > 
> > > WARNING: Missing Signed-off-by: line by nominal patch author 'Jacob Chen <jacob2.chen@rock-chips.com>'
> > > 
> > > Looking at this series I see duplicate Signed-off-by entries for Jacob Chen and a total
> > > of three different email addresses:
> > > 
> > > jacob2.chen@rock-chips.com
> > > jacob-chen@rock-chips.com
> > > cc@rock-chips.com
> > 
> > And I see a name in the Maintainers file as Jacob Chen <jacob-chen@iotwrt.com>.
> > I was wondering if I could replace the email by jacob-chen@iotwrt.com, or if I should
> > keep the original ones.
> > 
> > Helen
> > 
> 
> "jacob2.chen@rock-chips.com"/"jacob-chen@rock-chips.com" is me and
> "cc@rock-chips.com" is another one.
> ' jacob-chen@rock-chips.com' is invalid now,  so you could replace the
> email by 'jacob-chen@iotwrt.com'.
> 

Authorship and SOB can't be changed freely, the original must be retained,
because this gives proper credit to the company that sponsored the work.

I.e. if your mail used to be jacob2.chen at rock-chips.com, then I think
we can use that. And if cc at rock-chips.com is a different engineer,
also named Jacob Chen, perhaps we can mention that somewhere to reduce the
confusion.

Thanks,
Ezequiel
Tomasz Figa Nov. 19, 2019, 1:03 p.m. UTC | #6
On Tue, Nov 19, 2019 at 9:56 PM Ezequiel Garcia <ezequiel@collabora.com> wrote:
>
> Hello Jacob,
>
> Thanks for the insight.
>
> On Tue, 2019-11-19 at 18:16 +0800, Jacob Chen wrote:
> > Hi Helen ,
> >
> > Helen Koike <helen.koike@collabora.com> 于2019年11月14日周四 下午6:59写道:
> > >
> > >
> > > On 11/14/19 6:21 AM, Hans Verkuil wrote:
> > > > On 11/14/19 6:12 AM, 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>
> > > > > [refactored for upstream]
> > > > > Signed-off-by: Helen Koike <helen.koike@collabora.com>
> > > >
> > > > checkpatch gives me:
> > > >
> > > > WARNING: Missing Signed-off-by: line by nominal patch author 'Jacob Chen <jacob2.chen@rock-chips.com>'
> > > >
> > > > Looking at this series I see duplicate Signed-off-by entries for Jacob Chen and a total
> > > > of three different email addresses:
> > > >
> > > > jacob2.chen@rock-chips.com
> > > > jacob-chen@rock-chips.com
> > > > cc@rock-chips.com
> > >
> > > And I see a name in the Maintainers file as Jacob Chen <jacob-chen@iotwrt.com>.
> > > I was wondering if I could replace the email by jacob-chen@iotwrt.com, or if I should
> > > keep the original ones.
> > >
> > > Helen
> > >
> >
> > "jacob2.chen@rock-chips.com"/"jacob-chen@rock-chips.com" is me and
> > "cc@rock-chips.com" is another one.
> > ' jacob-chen@rock-chips.com' is invalid now,  so you could replace the
> > email by 'jacob-chen@iotwrt.com'.
> >
>
> Authorship and SOB can't be changed freely, the original must be retained,
> because this gives proper credit to the company that sponsored the work.
>
> I.e. if your mail used to be jacob2.chen at rock-chips.com, then I think
> we can use that. And if cc at rock-chips.com is a different engineer,
> also named Jacob Chen, perhaps we can mention that somewhere to reduce the
> confusion.

Some patches have been developed by Jacob <jacob2.chen at
rock-chips.com>, some by Jacob <cc at rock-chips.com> and some by
both.

Some patches have been also re-posted by Jacob after leaving Rockchip
AFAIR, from the <jacob-chen at iotwrt.com> address. Those should have
<jacob2.chen at rock-chips.com> as From: and include sign-offs from
both <jacob2.chen at rock-chips.com> and <jacob-chen at iotwrt.com>.

So the conclusion is that the original sign-offs should be retained
+/- typos fixed.

For typos, was <jacob-chen at rock-chips.com> a typo of <jacob2.chen
at rock-chips.com> or a typo of <jacob-chen at iotwrt.com>?

Best regards,
Tomasz
diff mbox series

Patch

diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
new file mode 100644
index 000000000000..103b5cb79b7c
--- /dev/null
+++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
@@ -0,0 +1,23 @@ 
+.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
+
+.. _v4l2-meta-fmt-rkisp1-params:
+
+============================
+V4L2_META_FMT_RK_ISP1_PARAMS
+============================
+
+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.
+
+The parameters consist of multiple modules.
+The module won't be updated if the corresponding bit was not set in module_*_update.
+
+.. kernel-doc:: include/uapi/linux/rkisp1-config.h
+   :functions: rkisp1_isp_params_cfg
diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
new file mode 100644
index 000000000000..4ad303f96421
--- /dev/null
+++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
@@ -0,0 +1,22 @@ 
+.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
+
+.. _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/rkisp1-config.h`` header file.
+
+.. kernel-doc:: include/uapi/linux/rkisp1-config.h
+   :functions: rkisp1_stat_buffer