Re: [Ksummit-discuss] [RFC PATCH 2/3] MAINTAINERS, Handbook: Subsystem Profile

Anyway, RFC patch follows. - [PATCH] [RFC] Add a system profile description for media subsystem This RFC aligns with current Dan's proposal for having subsystem specific ruleset stored at the Kernel tree. On this initial RFC, I opted to not add the reviewers e-mail (adding just a "<>") as a boilerplate. If we decide keeping emails there, I'll add them.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung(a)kernel.org&gt; diff --git a/Documentation/media/subsystem-profile.rst b/Documentation/media/subsystem-profile.rst new file mode 100644 index 000000000000..7a5d6f691d05 --- /dev/null +++ b/Documentation/media/subsystem-profile.rst @@ -0,0 +1,186 @@ +Media Subsystem Profile +======================= + +Overview +-------- + +The media subsystem cover support for a variety of devices: stream

+capture, analog and digital TV, cameras, remote controllers, HDMI CEC +and media pipeline control. + +Both our 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. + +Due to the size and wide scope of the media subsystem, our +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 +if the patches are following the subsystem rules and are properly using +the media internal and external APIs. + +We have 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. + +Patches for the media subsystem should be sent to the media mailing list +at linux-media(a)vger.kernel.org as plain text only e-mail. emails with

+HTML will be automacially rejected by the mail server.

+ +Our 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. + +Core +---- + +Documentation ++++++++++++++ + +F: Documentation/media + +Kernelspace API headers ++++++++++++++++++++++++ + +F: include/media/*.h + +Digital TV Core ++++++++++++++++ + +F: drivers/media/dvb-core + +HDMI CEC Core ++++++++++++++ + +F: drivers/media/cec + +Media Controller Core ++++++++++++++++++++++ + +F: drivers/media/media-\*.[ch] + +Remote Controller Core +++++++++++++++++++++++ + +F: drivers/media/rc/rc-core-priv.h +F: drivers/media/rc/rc-ir-raw.c +F: drivers/media/rc/rc-main.c +F: drivers/media/rc/ir\*-decoder.c +F: drivers/media/rc/lirc_dev.c + +Video4linux Core +++++++++++++++++ + +F: drivers/media/v4l2-core + +Patches or Pull requests +------------------------ + +All patches should be submitted via e-mail for review. We use

+pull requests on our workflow between sub-maintainers and the +maintainer. + + +Last day for new feature submissions +------------------------------------ + +Before -rc5 + + +Last day to merge features +-------------------------- + +Before -rc7 + + +Non-author Ack / Review Tags Required +------------------------------------- + +Not required, but desirable + + +Test Suite +---------- + +Use the several *-compliance tools that are part of the v4l-utils +package. + + +Trusted Reviewers +----------------- + +Sub-maintainers ++++++++++++++++ + +At the media subsystem, we have a group of senior developers that are +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: + +- Sensor drivers + + R: Sakari Ailus <> + +- V4L2 drivers + + R: Hans Verkuil <> + +- Media controller drivers + + R: Laurent Pinchart <> + +- HDMI CEC + +- Remote Controllers + + R: Sean Young <> + +- Digital TV + + R: Michael Krufky <> + R: Sean Young <> + + +Resubmit 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.

+ +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.

+ +Time Zone / Office Hours +------------------------ + +Media developers are distributed all around the globe. So, don't assume +that we're on your time zone. We usually don't work on local holidays or +at weekends. Please also notice that, during the Kernel merge window, +we're usually busy ensuring that everything goes smoothly, meaning that +we usually have a lot of patches waiting for review just after that. So +you should expect a higher delay during the merge window and one week +before/after it. + + +Checkpatch / Style cleanups +--------------------------- + +Standalone style-cleanups are welcome, 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.

Cheers.-