mbox series

[v2,0/2] media: admin-guide: add documentation for rkisp1

Message ID 20200818102703.30471-1-dafna.hirschfeld@collabora.com (mailing list archive)
Headers show
Series media: admin-guide: add documentation for rkisp1 | expand

Message

Dafna Hirschfeld Aug. 18, 2020, 10:27 a.m. UTC
Two patches that document the rkisp1 driver in the Documentation
directory.

patch 1 adds documentation to the specific metadata formats
used by the driver.

patch 2 adds a documentation of the driver.

The documentation assumes that the patchsets:

"v4l2: add support for colorspace conversion API (CSC) for video capture and subdevices"
https://patchwork.kernel.org/project/linux-media/list/?series=334393

"media: staging: rkisp1: add support to V4L2_CAP_IO_MC"
https://patchwork.kernel.org/cover/11680993/

were accepted and it documents the features that those patchsets add.

changes from v1:
----------------
- limit lines within 80 chars
- rephrasing and fixing issues due to comments

Dafna Hirschfeld (2):
  media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata
    formats in pixfmt-meta-rkisp1.rst
  media: admin-guide: add documentation file rkisp1.rst

 Documentation/admin-guide/media/rkisp1.dot    |  18 ++
 Documentation/admin-guide/media/rkisp1.rst    | 181 ++++++++++++++++++
 .../admin-guide/media/v4l-drivers.rst         |   1 +
 .../userspace-api/media/v4l/meta-formats.rst  |   1 +
 .../media/v4l/pixfmt-meta-rkisp1.rst          |  49 +++++
 .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    |  23 ---
 .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      |  22 ---
 7 files changed, 250 insertions(+), 45 deletions(-)
 create mode 100644 Documentation/admin-guide/media/rkisp1.dot
 create mode 100644 Documentation/admin-guide/media/rkisp1.rst
 create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
 delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
 delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst

Comments

Hans Verkuil Sept. 17, 2020, 10:52 a.m. UTC | #1
On 18/08/2020 12:27, Dafna Hirschfeld wrote:
> Two patches that document the rkisp1 driver in the Documentation
> directory.
> 
> patch 1 adds documentation to the specific metadata formats
> used by the driver.
> 
> patch 2 adds a documentation of the driver.
> 
> The documentation assumes that the patchsets:
> 
> "v4l2: add support for colorspace conversion API (CSC) for video capture and subdevices"
> https://patchwork.kernel.org/project/linux-media/list/?series=334393
> 
> "media: staging: rkisp1: add support to V4L2_CAP_IO_MC"
> https://patchwork.kernel.org/cover/11680993/

The MAINTAINERS file needs to be updated for these new doc files. Just post a new patch for
this, no need for a v3.

Regards,

	Hans

> 
> were accepted and it documents the features that those patchsets add.
> 
> changes from v1:
> ----------------
> - limit lines within 80 chars
> - rephrasing and fixing issues due to comments
> 
> Dafna Hirschfeld (2):
>   media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata
>     formats in pixfmt-meta-rkisp1.rst
>   media: admin-guide: add documentation file rkisp1.rst
> 
>  Documentation/admin-guide/media/rkisp1.dot    |  18 ++
>  Documentation/admin-guide/media/rkisp1.rst    | 181 ++++++++++++++++++
>  .../admin-guide/media/v4l-drivers.rst         |   1 +
>  .../userspace-api/media/v4l/meta-formats.rst  |   1 +
>  .../media/v4l/pixfmt-meta-rkisp1.rst          |  49 +++++
>  .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    |  23 ---
>  .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      |  22 ---
>  7 files changed, 250 insertions(+), 45 deletions(-)
>  create mode 100644 Documentation/admin-guide/media/rkisp1.dot
>  create mode 100644 Documentation/admin-guide/media/rkisp1.rst
>  create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
>  delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>  delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>
Dafna Hirschfeld Sept. 17, 2020, 3:06 p.m. UTC | #2
Am 17.09.20 um 12:52 schrieb Hans Verkuil:
> On 18/08/2020 12:27, Dafna Hirschfeld wrote:
>> Two patches that document the rkisp1 driver in the Documentation
>> directory.
>>
>> patch 1 adds documentation to the specific metadata formats
>> used by the driver.
>>
>> patch 2 adds a documentation of the driver.
>>
>> The documentation assumes that the patchsets:
>>
>> "v4l2: add support for colorspace conversion API (CSC) for video capture and subdevices"
>> https://patchwork.kernel.org/project/linux-media/list/?series=334393
>>
>> "media: staging: rkisp1: add support to V4L2_CAP_IO_MC"
>> https://patchwork.kernel.org/cover/11680993/
> 
> The MAINTAINERS file needs to be updated for these new doc files. Just post a new patch for
> this, no need for a v3.

Done,

thanks,
Dafna

> 
> Regards,
> 
> 	Hans
> 
>>
>> were accepted and it documents the features that those patchsets add.
>>
>> changes from v1:
>> ----------------
>> - limit lines within 80 chars
>> - rephrasing and fixing issues due to comments
>>
>> Dafna Hirschfeld (2):
>>    media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata
>>      formats in pixfmt-meta-rkisp1.rst
>>    media: admin-guide: add documentation file rkisp1.rst
>>
>>   Documentation/admin-guide/media/rkisp1.dot    |  18 ++
>>   Documentation/admin-guide/media/rkisp1.rst    | 181 ++++++++++++++++++
>>   .../admin-guide/media/v4l-drivers.rst         |   1 +
>>   .../userspace-api/media/v4l/meta-formats.rst  |   1 +
>>   .../media/v4l/pixfmt-meta-rkisp1.rst          |  49 +++++
>>   .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    |  23 ---
>>   .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      |  22 ---
>>   7 files changed, 250 insertions(+), 45 deletions(-)
>>   create mode 100644 Documentation/admin-guide/media/rkisp1.dot
>>   create mode 100644 Documentation/admin-guide/media/rkisp1.rst
>>   create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
>>   delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>>   delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>>
>