From: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
To: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Cc: ksummit-discuss@lists.linuxfoundation.org,
Linux Media Mailing List <linux-media@vger.kernel.org>
Subject: Re: [Ksummit-discuss] [PATCH] media: add a subsystem profile documentation
Date: Wed, 18 Sep 2019 15:36:20 +0300 [thread overview]
Message-ID: <20190918123620.GA6306@pendragon.ideasonboard.com> (raw)
In-Reply-To: <434c05bddd2b364e607e565227487910a8dd9793.1568391461.git.mchehab+samsung@kernel.org>
Hi Mauro,
On Fri, Sep 13, 2019 at 01:19:21PM -0300, Mauro Carvalho Chehab wrote:
> Document the basic policies of the media subsystem profile.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>
> That's basically a modified version of:
> https://patchwork.linuxtv.org/patch/52999/
>
> Applied to the new template
>
> Documentation/media/index.rst | 1 +
> .../media/maintainer-entry-profile.rst | 140 ++++++++++++++++++
> MAINTAINERS | 1 +
> 3 files changed, 142 insertions(+)
> create mode 100644 Documentation/media/maintainer-entry-profile.rst
>
> diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst
> index 0301c25ff887..ac94685b822a 100644
> --- a/Documentation/media/index.rst
> +++ b/Documentation/media/index.rst
> @@ -12,6 +12,7 @@ Linux Media Subsystem Documentation
> .. toctree::
> :maxdepth: 2
>
> + maintainer-entry-profile
> media_uapi
> media_kapi
> dvb-drivers/index
> diff --git a/Documentation/media/maintainer-entry-profile.rst b/Documentation/media/maintainer-entry-profile.rst
> new file mode 100644
> index 000000000000..81d3b0f9c36a
> --- /dev/null
> +++ b/Documentation/media/maintainer-entry-profile.rst
> @@ -0,0 +1,140 @@
> +Media Subsystem Profile
> +=======================
> +
> +Overview
> +--------
> +
> +The media subsystem cover support for a variety of devices: stream
s/cover/covers/
> +capture, analog and digital TV, cameras, remote controllers, HDMI CEC
> +and media pipeline control.
> +
> +It covers, mainly, the contents of those directories:
> +
> + - drivers/media
> + - drivers/staging/media
> + - Documentation/media
> + - include/media
> +
> +Both media userspace and Kernel APIs are documented and should be kept in
> +sync with the API changes. It means that all patches that add new
> +features to the subsystem should also bring changes to the corresponding
> +API files.
> +
> +Also, patches for device drivers that changes the Open Firmware/Device
> +Tree bindings should be reviewed by the Device Tree maintainers.
You may want to make it clear that this covers bindings only, not driver
code that parses the DT. I would just remove "for device drivers", as
the rule should also apply to DT bindings documentation that is not
driver-specific.
> +Due to the size and wide scope of the media subsystem, media's
> +maintainership model is to have sub-maintainers that have a broad
> +knowledge of an specific aspect of the subsystem. It is a
> +sub-maintainers task to review the patches, providing feedback to users
s/sub-maintainers/sub-maintainer's/
> +if the patches are following the subsystem rules and are properly using
> +the media internal and external APIs.
> +
> +Patches for the media subsystem should be sent to the media mailing list
> +at linux-media@vger.kernel.org as plain text only e-mail. Emails with
> +HTML will be automatically rejected by the mail server. There's no need
> +to copy the maintainer or sub-maintainer(s).
There's too much traffic on mailing lists for me to follow everything, I
much prefer being CC'ed on patches.
> +Media's workflow is heavily based on Patchwork, meaning that, once a patch
> +is submitted, it should appear at:
> +
> + - https://patchwork.linuxtv.org/project/linux-media/list/
> +
> +If it doesn't automatically appear there after a few minutes, then
> +probably something got wrong on your submission. Please check if the
> +email is in plain text only and if your emailer is not mangling with
> +whitespaces before complaining or submit it again.
> +
> +Sub-maintainers
> ++++++++++++++++
> +
> +At the media subsystem, we have a group of senior developers that are
How about "experienced" instead of "senior" ? Quality doesn't always
come with age, neither for people nor wine :-)
> +responsible for doing the code reviews at the drivers (called
> +sub-maintainers), and another senior developer responsible for the
> +subsystem as a hole. For core changes, whenever possible, multiple
> +media (sub-)maintainers do the review.
> +
> +The sub-maintainers work on specific areas of the subsystem, as
> +described below:
> +
> +Digital TV:
> + Sean Young <sean@mess.org>
> +
> +HDMI CEC:
> + Hans Verkuil <hverkuil@xs4all.nl>
> +
> +Media controller drivers:
> + Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> +
> +Remote Controllers:
> + Sean Young <sean@mess.org>
> +
> +Sensor drivers:
> + Sakari Ailus <sakari.ailus@linux.intel.com>
> +
> +V4L2 drivers:
> + Hans Verkuil <hverkuil@xs4all.nl>
> +
> +Submit Checklist Addendum
> +-------------------------
> +
> +There is a set of compliance tools at https://git.linuxtv.org/v4l-utils.git/
> +that should be used in order to check if the drivers are properly
> +implementing the media APIs.
> +
> +Those tests need to be passed before the patches go upstream.
s/need to be passed/need to pass/
> +
> +Also, please notice that we build the Kernel with::
> +
> + make CF=-D__CHECK_ENDIAN__ CONFIG_DEBUG_SECTION_MISMATCH=y C=1 W=1 CHECK=check_script
> +
> +Where the check script is::
> +
> + #!/bin/bash
> + /devel/smatch/smatch -p=kernel $@ >&2
> + /devel/sparse/sparse $@ >&2
> +
> +Be sure to not introduce new warnings on your patches.
While static analysers deliver value, I fear this is a high barrier to
entry for new contributors.
> +
> +Key Cycle Dates
> +---------------
> +
> +New submissions can be sent at any time, but if they intend to hit the
> +next merge window they should be sent before -rc5, and ideally stabilized
> +in the linux-media branch by -rc6.
> +
> +Coding Style Addendum
> +---------------------
> +
> +Media development uses checkpatch on strict mode to verify the code style, e. g.::
> +
> + $ ./script/checkpatch.pl --strict
But we still accept some warnings. I think this should be documented.
> +
> +Review Cadence
> +--------------
> +
> +Provided that your patch is at https://patchwork.linuxtv.org, it should
> +be sooner or later handled, so you don't need to re-submit a patch.
> +
> +Except for bug fixes, we don't usually add new patches to the development
> +tree between -rc6 and the next -rc1.
> +
> +Please notice that the media subsystem is a high traffic one, so it
> +could take a while for us to be able to review your patches. Feel free
> +to ping if you don't get a feedback on a couple of weeks or to ask
s/on a/in a/
> +other developers to publicly add Reviewed-by and, more importantly,
> +Tested-by tags.
> +
> +Please notice that we expect a detailed description for Tested-by,
s/notice/note/
> +identifying what boards were used at the test and what it was tested.
> +
> +Style Cleanup Patches
> +---------------------
> +
> +Style-cleanups are welcome when they come together with other changes
> +at the files where the style changes will affect.
> +
> +We may accept pure standalone style-cleanups, but they should be grouped
> +per directory. So, for example, if you're doing a cleanup at drivers
> +under drivers/media, please send a single patch for all drivers under
> +drivers/media/pci, another one for drivers/media/usb and so on.
How about also stating that if the cleanup is low volume, a single patch
for the whole subsystem is preferred ? I think that should actually be
the rule, with a split to ease review only when the patch would be too
big.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7c62b45201d7..e7f44ec05a42 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -10077,6 +10077,7 @@ W: https://linuxtv.org
> Q: http://patchwork.kernel.org/project/linux-media/list/
> T: git git://linuxtv.org/media_tree.git
> S: Maintained
> +P: Documentation/media/maintainer-entry-profile.rst
> F: Documentation/devicetree/bindings/media/
> F: Documentation/media/
> F: drivers/media/
--
Regards,
Laurent Pinchart
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
next prev parent reply other threads:[~2019-09-18 12:36 UTC|newest]
Thread overview: 82+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-11 15:48 [Ksummit-discuss] [PATCH v2 0/3] Maintainer Entry Profiles Dan Williams
2019-09-11 15:48 ` [Ksummit-discuss] [PATCH v2 1/3] MAINTAINERS: Reclaim the P: tag for Maintainer Entry Profile Dan Williams
2019-09-13 15:37 ` Mauro Carvalho Chehab
2019-09-11 15:48 ` [Ksummit-discuss] [PATCH v2 2/3] Maintainer Handbook: " Dan Williams
2019-09-16 12:35 ` Jani Nikula
2019-10-01 13:55 ` Jonathan Corbet
2019-10-01 18:17 ` Martin K. Petersen
2019-11-07 20:13 ` Jonathan Corbet
2019-11-08 2:41 ` Dan Williams
2019-09-11 15:48 ` [Ksummit-discuss] [PATCH v2 3/3] libnvdimm, MAINTAINERS: " Dan Williams
2019-09-11 17:42 ` Vishal Verma
2019-09-11 18:43 ` Dan Carpenter
2019-09-11 22:11 ` Jens Axboe
2019-09-12 7:41 ` Dan Williams
[not found] ` <CANiq72k2so3ZcqA3iRziGY=Shd_B1=qGoXXROeAF7Y3+pDmqyA@mail.gmail.com>
2019-09-12 10:18 ` Joe Perches
2019-09-13 7:09 ` Jonathan Corbet
2019-09-13 11:48 ` Dan Carpenter
2019-09-13 12:18 ` Dan Williams
2019-09-13 15:00 ` Randy Dunlap
2019-09-13 15:46 ` Rob Herring
2019-09-13 16:42 ` Joe Perches
2019-09-13 19:32 ` Rob Herring
2019-09-13 17:57 ` Geert Uytterhoeven
2019-09-16 12:42 ` Jani Nikula
[not found] ` <20190917161608.GA12866@ziepe.ca>
2019-09-17 21:59 ` Dan Williams
2019-09-13 21:44 ` Martin K. Petersen
2019-09-16 7:01 ` Dan Carpenter
2019-09-16 17:08 ` Martin K. Petersen
2019-09-16 17:15 ` Mark Brown
2019-09-11 20:30 ` Joe Perches
2019-09-13 16:19 ` [Ksummit-discuss] [PATCH] media: add a subsystem profile documentation Mauro Carvalho Chehab
2019-09-13 16:19 ` Mauro Carvalho Chehab
2019-09-17 3:35 ` [Ksummit-discuss] single maintainer profile directory (was Re: [PATCH] media: add a subsystem profile documentation) Kees Cook
2019-09-17 13:28 ` Mauro Carvalho Chehab
2019-09-17 16:33 ` Kees Cook
2019-09-18 11:23 ` Mauro Carvalho Chehab
2019-09-18 17:39 ` Kees Cook
2019-09-18 18:35 ` Mauro Carvalho Chehab
2019-09-21 19:13 ` Jonathan Corbet
2019-09-21 19:45 ` Mauro Carvalho Chehab
2019-09-23 22:45 ` Kees Cook
2019-09-18 12:36 ` Laurent Pinchart [this message]
2019-09-18 13:57 ` [Ksummit-discuss] [PATCH] media: add a subsystem profile documentation Mauro Carvalho Chehab
2019-09-18 17:27 ` Laurent Pinchart
2019-09-18 18:48 ` Mauro Carvalho Chehab
2019-09-19 7:08 ` Dan Carpenter
2019-09-20 5:29 ` Joe Perches
2019-09-20 14:09 ` Daniel Vetter
2019-09-19 6:56 ` Dan Carpenter
2019-09-19 7:22 ` Geert Uytterhoeven
2019-09-19 8:49 ` Jani Nikula
2019-09-19 8:58 ` Geert Uytterhoeven
2019-09-19 9:52 ` Jani Nikula
2019-09-20 14:53 ` Laurent Pinchart
2019-09-20 14:59 ` Doug Anderson
2019-09-21 8:56 ` Jani Nikula
2019-09-23 15:58 ` Doug Anderson
2019-09-23 16:04 ` Jonathan Corbet
2019-09-19 9:52 ` Mauro Carvalho Chehab
2019-09-25 17:13 ` Joe Perches
2019-09-25 18:40 ` Kees Cook
2019-09-26 15:14 ` Joe Perches
2019-09-26 15:53 ` Kees Cook
2019-09-26 16:02 ` Joe Perches
2019-09-26 16:24 ` Kees Cook
2019-09-26 10:25 ` Geert Uytterhoeven
2019-09-18 13:59 ` [Ksummit-discuss] [PATCH v2] " Mauro Carvalho Chehab
[not found] ` <1e479f17-dbc8-b44d-bd1e-4229a6dbf151@collabora.com>
2019-09-18 14:11 ` Mauro Carvalho Chehab
2019-09-11 16:40 ` [Ksummit-discuss] [PATCH v2 0/3] Maintainer Entry Profiles Martin K. Petersen
2019-09-12 13:31 ` Bart Van Assche
2019-09-12 15:34 ` Joe Perches
2019-09-12 20:01 ` Bart Van Assche
2019-09-12 20:34 ` Joe Perches
2019-09-13 14:26 ` Rob Herring
2019-09-13 18:42 ` Joe Perches
2019-09-13 19:17 ` Mauro Carvalho Chehab
2019-09-13 20:33 ` Joe Perches
2019-09-13 12:56 ` Matthew Wilcox
2019-09-13 13:54 ` Mauro Carvalho Chehab
2019-09-13 14:59 ` Guenter Roeck
2019-09-13 22:03 ` Martin K. Petersen
2019-09-12 13:10 ` Bart Van Assche
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=20190918123620.GA6306@pendragon.ideasonboard.com \
--to=laurent.pinchart@ideasonboard.com \
--cc=ksummit-discuss@lists.linuxfoundation.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
/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).