Re: [PATCH] media: add a subsystem profile documentation
Em Mon, 08 Mar 2021 16:53:16 -0700 Jonathan Corbet escreveu: > Mauro Carvalho Chehab writes: > > > Document the basic policies of the media subsystem profile. > > > > Signed-off-by: Mauro Carvalho Chehab > > --- > > Documentation/driver-api/media/index.rst | 2 + > > .../media/maintainer-entry-profile.rst| 206 ++ > > .../maintainer/maintainer-entry-profile.rst | 1 + > > 3 files changed, 209 insertions(+) > > create mode 100644 > > Documentation/driver-api/media/maintainer-entry-profile.rst > > This all looks good to me; would you like me to take it or were you > going to send it upward yourself? I prefer merging it via the media tree, as we're planning to document additional guidelines that drivers need to comply to to be upstreamable, such as using V4L2 standard ioctls instead of vendor-specific extensions to configure parameters that are handled by V4L2, not requiring a closed-source daemon, etc. > > Thanks, > > jon Thanks, Mauro
Re: [PATCH] media: add a subsystem profile documentation
Mauro Carvalho Chehab writes: > Document the basic policies of the media subsystem profile. > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/driver-api/media/index.rst | 2 + > .../media/maintainer-entry-profile.rst| 206 ++ > .../maintainer/maintainer-entry-profile.rst | 1 + > 3 files changed, 209 insertions(+) > create mode 100644 > Documentation/driver-api/media/maintainer-entry-profile.rst This all looks good to me; would you like me to take it or were you going to send it upward yourself? Thanks, jon
[PATCH] media: add a subsystem profile documentation
Document the basic policies of the media subsystem profile. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/media/index.rst | 2 + .../media/maintainer-entry-profile.rst| 206 ++ .../maintainer/maintainer-entry-profile.rst | 1 + 3 files changed, 209 insertions(+) create mode 100644 Documentation/driver-api/media/maintainer-entry-profile.rst diff --git a/Documentation/driver-api/media/index.rst b/Documentation/driver-api/media/index.rst index c140692454b1..2ad71dfa8828 100644 --- a/Documentation/driver-api/media/index.rst +++ b/Documentation/driver-api/media/index.rst @@ -28,6 +28,8 @@ Please see: :maxdepth: 5 :numbered: +maintainer-entry-profile + v4l2-core dtv-core rc-core diff --git a/Documentation/driver-api/media/maintainer-entry-profile.rst b/Documentation/driver-api/media/maintainer-entry-profile.rst new file mode 100644 index ..4c6ec6de35c9 --- /dev/null +++ b/Documentation/driver-api/media/maintainer-entry-profile.rst @@ -0,0 +1,206 @@ +Media Subsystem Profile +=== + +Overview + + +The media subsystem covers support for a variety of devices: stream +capture, analog and digital TV streams, cameras, remote controllers, HDMI CEC +and media pipeline control. + +It covers, mainly, the contents of those directories: + + - drivers/media + - drivers/staging/media + - Documentation/admin-guide/media + - Documentation/driver-api/media + - Documentation/userspace-api/media + - Documentation/devicetree/bindings/media/\ [1]_ + - include/media + +.. [1] Device tree bindings are maintained by the + OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS maintainers + (see the MAINTAINERS file). So, changes there must be reviewed + by them before being merged via the media subsystem's development + tree. + +Both media userspace and Kernel APIs are documented and the documentation +must be kept in sync with the API changes. It means that all patches that +add new features to the subsystem must also bring changes to the +corresponding API files. + +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 a specific aspect of the subsystem. It is the 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 kernel and +userspace APIs. + +Patches for the media subsystem must be sent to the media mailing list +at linux-me...@vger.kernel.org as plain text only e-mail. Emails with +HTML will be automatically rejected by the mail server. It could be wise +to also copy the sub-maintainer(s). + +Media's workflow is heavily based on Patchwork, meaning that, once a patch +is submitted, the e-mail will first be accepted by the mailing list +server, and, after a while, 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 went wrong on your submission. Please check if the +email is in plain text\ [2]_ only and if your emailer is not mangling +whitespaces before complaining or submitting them again. + +You can check if the mailing list server accepted your patch, by looking at: + + - https://lore.kernel.org/linux-media/ + +.. [2] If your email contains HTML, the mailing list server will simply + drop it, without any further notice. + + +Media maintainers ++ + +At the media subsystem, we have a group of senior developers that +are responsible for doing the code reviews at the drivers (also known as +sub-maintainers), and another senior developer responsible for the +subsystem as a whole. For core changes, whenever possible, multiple +media maintainers do the review. + +The media maintainers that work on specific areas of the subsystem are: + +- Digital TV and remote controllers: +Sean Young + +- HDMI CEC: +Hans Verkuil + +- Media controller drivers: +Laurent Pinchart + +- v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers: +Sakari Ailus + +- V4L2 drivers and core V4L2 frameworks: +Hans Verkuil + +The subsystem maintainer is: + Mauro Carvalho Chehab + +Media maintainers may delegate a patch to other media maintainers as needed. +On such case, checkpatch's ``delegate`` field indicates who's currently +responsible for reviewing a patch. + +Submit Checklist Addendum +- + +Patches that change the Open Firmware/Device Tree bindings must be +reviewed by the Device Tree maintainers. So, DT maintainers should be +Cc:ed when those are submitted via devicet...@vger.kernel.org mailing +list. + +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: + +
[PATCH] media: add a subsystem profile documentation
Document the basic policies of the media subsystem profile. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/media/index.rst | 2 + .../media/maintainer-entry-profile.rst| 159 ++ .../maintainer/maintainer-entry-profile.rst | 1 + 3 files changed, 162 insertions(+) create mode 100644 Documentation/driver-api/media/maintainer-entry-profile.rst diff --git a/Documentation/driver-api/media/index.rst b/Documentation/driver-api/media/index.rst index c140692454b1..2ad71dfa8828 100644 --- a/Documentation/driver-api/media/index.rst +++ b/Documentation/driver-api/media/index.rst @@ -28,6 +28,8 @@ Please see: :maxdepth: 5 :numbered: +maintainer-entry-profile + v4l2-core dtv-core rc-core diff --git a/Documentation/driver-api/media/maintainer-entry-profile.rst b/Documentation/driver-api/media/maintainer-entry-profile.rst new file mode 100644 index ..6393c1181757 --- /dev/null +++ b/Documentation/driver-api/media/maintainer-entry-profile.rst @@ -0,0 +1,159 @@ +Media Subsystem Profile +=== + +Overview + + +The media subsystem covers support for a variety of devices: stream +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. + +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 a specific aspect of the subsystem. It is the 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 kernel and +userspace APIs. + +Patches for the media subsystem should be sent to the media mailing list +at linux-me...@vger.kernel.org as plain text only e-mail. Emails with +HTML will be automatically rejected by the mail server. It could be wise +to also copy the sub-maintainer(s). + +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 submitting them again. + +Sub-maintainers + +At the media subsystem, we have a group of experienced 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: + +Digital TV: + Sean Young + +HDMI CEC: + Hans Verkuil + +Media controller drivers: + Laurent Pinchart + +Remote Controllers: + Sean Young + +Sensor drivers: + Sakari Ailus + +V4L2 drivers: + Hans Verkuil + +Submit Checklist Addendum +- + +Patches that change the Open Firmware/Device Tree bindings should be +reviewed by the Device Tree maintainers. So, DT maintainers should be +c/c when those are submitted. + +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 pass before the patches go upstream. + +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 without a +very good reason. + +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 ideally +be one patch for the hole subsystem (if the cleanup is low volume), +or at least be grouped per directory. So, for example, if you're doing +big cleanup change set 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. + +Coding Style Addendum ++ + +Media development uses checkpatch on strict mode to verify the code style, +e. g.:: + + $ ./script/checkpatch.pl --strict
