Document the new media-committer's model

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

Reviewed-by Ricardo Ribalda <[email protected]>

---
 .../media/maintainer-entry-profile.rst        | 208 ++++++++++++++----
 MAINTAINERS                                   |   1 +
 2 files changed, 163 insertions(+), 46 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +5 -5

index ffc712a5f632..dc764163cf1c 100644
@@ -27,19 +27,139 @@ It covers, mainly, the contents of those directories:
 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.
+corresponding API documentation 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
+Due to the size and wide scope of the media subsystem, the media's
+maintainership model is to have committers that have a broad knowledge of
+a specific aspect of the subsystem. It is the committers' 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

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -0

+patches directly to the development tree. These developers are called
+Media committers and are divided into the following categories:
+
+- Committers:

Documentation/driver-api/media/maintainer-entry-profile.rst +14 -0

+
+All media committers shall explicitly agree with the Kernel development process
+as described at Documentation/process/index.rst and to the Kernel
+development rules inside the Kernel documentation, including its code of
+conduct.
+
+Media development tree
+----------------------
+
+The main development tree used by the media subsystem is hosted at LinuxTV.org,
+where we also maintain news about the subsystem, wiki pages and a patchwork
+instance where we track patches though their lifetime.
+
+The main tree used by media developers is at:

Documentation/driver-api/media/maintainer-entry-profile.rst +12 -0

+Documentation/process/index.rst.
+
+It means that patches shall be submitted as plain text only via e-mail to
[email protected]. While subscription is not mandatory, you
+can find details about how to subscribe to it and to see its archives at:
+
+  https://subspace.kernel.org/vger.kernel.org.html
+
+Emails with HTML will be automatically rejected by the mail server.
+
+It could be wise to also copy the media committer(s). You should use
+``scripts/get_maintainers.pl`` to identify whom else needs to be copied.

Documentation/driver-api/media/maintainer-entry-profile.rst +17 -0

+
+3. Fixes for issues not present at the latest released kernel shall
+   be either against a -rc kernel for an upcoming release or
+   against the ``fixes`` branch of the media.git tree.
+
+Patches with fixes shall have:
+
+- a ``Fixes:`` tag pointing to the first commit that introduced the bug;
+- when applicable, a ``Cc: [email protected]``.
+
+Patches that were fixing bugs publicly reported by someone at the
[email protected] mailing list shall have:
+
+- a ``Reported-by:`` tag immediately followed by a ``Closes:`` tag.
+
+Patches that change API shall update documentation accordingly at the
+same patch series.

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+   contributor. If you are not in such group, please don't submit
 
+   pull requests, as they will not be processed.
+
+b. Committers' workflow: patches are handled by media committers::
+
+     +------+   +---------+   +--------------------+   +-----------+   +---------+
+     |e-mail|-->|patchwork|-->|committers merge at |-->|maintainers|-->|media.git|
+     +------+   |picks it |   |media-committers.git|   |approval   |   +---------+
+                +---------+   +--------------------+   +-----------+
+

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -0

+
+Failures during e-mail submission
++++++++++++++++++++++++++++++++++
 
 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

Documentation/driver-api/media/maintainer-entry-profile.rst +18 -11

@@ -47,51 +167,48 @@ 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
+If it doesn't automatically appear there after some time [2]_, 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
+email is in plain text\ [3]_ 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:
+To troubleshoot problems, you should first check if the mailing list
+server has accepted your patch, by looking at:
 
    - https://lore.kernel.org/linux-media/
 
-.. [2] If your email contains HTML, the mailing list server will simply
+If the patch is there and not at patchwork, it is likely that your e-mailer
+mangled the patch. Patchwork internally has a logic that checks if the
+received e-mail contain a valid patch. Any whitespace and new line
+breakages mangling the patch won't be recognized by patchwork, thus such
+patch will be rejected.
+
+.. [2] It usually takes a few minutes for the patch to arrive, but
+       the e-mail server may be busy, so it may take up to a few hours
+       for a patch to be picked by patchwork.
+
+.. [3] If your email contains HTML, the mailing list server will simply
        drop it, without any further notice.
 
+.. _media-developers-gpg:
 
-Media maintainers
-+++++++++++++++++
+Authentication for pull and merge requests
+++++++++++++++++++++++++++++++++++++++++++
 
-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.

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -23

-- HDMI CEC:
-    Hans Verkuil <[email protected]>
+Subsystem maintainers
+---------------------
 
-- Media controller drivers:
-    Laurent Pinchart <[email protected]>
-
-- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers:
-    Sakari Ailus <[email protected]>
-
-- V4L2 drivers and core V4L2 frameworks:
-    Hans Verkuil <[email protected]>
-
-The subsystem maintainer is:
-  Mauro Carvalho Chehab <[email protected]>
-
-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.
+The subsystem maintainers are:
+  - Mauro Carvalho Chehab <[email protected]> and
+  - Hans Verkuil <[email protected]>
 
 Submit Checklist Addendum
 -------------------------

@@ -108,17 +225,14 @@ implementing the media APIs:
 ====================	=======================================================
 Type			Tool
 ====================	=======================================================
-V4L2 drivers\ [3]_	``v4l2-compliance``
+V4L2 drivers\ [4]_	``v4l2-compliance``
 V4L2 virtual drivers	``contrib/test/test-media``
 CEC drivers		``cec-compliance``
 ====================	=======================================================
 
-.. [3] The ``v4l2-compliance`` also covers the media controller usage inside
+.. [4] The ``v4l2-compliance`` also covers the media controller usage inside
        V4L2 drivers.
 
-Other compilance tools are under development to check other parts of the
-subsystem.
-
 Those tests need to pass before the patches go upstream.
 
 Also, please notice that we build the Kernel with::

@@ -134,6 +248,8 @@ Where the check script is::
 Be sure to not introduce new warnings on your patches without a
 very good reason.
 
+Please see `Media development workflow`_ for e-mail submission rules.
+
 Style Cleanup Patches
 +++++++++++++++++++++
 

@@ -199,7 +315,7 @@ 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 in a couple of weeks or to ask
-other developers to publicly add Reviewed-by and, more importantly,
+other developers to publicly add ``Reviewed-by:`` and, more importantly,
 ``Tested-by:`` tags.
 
 Please note that we expect a detailed description for ``Tested-by:``,

MAINTAINERS +1 -0

index 1e930c7a58b1..c77f56a2e695 100644
@@ -14510,6 +14510,7 @@ MEDIA INPUT INFRASTRUCTURE (V4L/DVB)
 M:	Mauro Carvalho Chehab <[email protected]>
 L:	[email protected]
 S:	Maintained
+P:	Documentation/driver-api/media/maintainer-entry-profile.rst
 W:	https://linuxtv.org
 Q:	http://patchwork.kernel.org/project/linux-media/list/
 T:	git git://linuxtv.org/media.git

Hi Mauro,

Thanks for the set.

Looks good overall, please still see my comments below.

Quoted 33 lines · Mauro Carvalho Chehab

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

Reviewed-by Ricardo Ribalda <[email protected]>

---
 .../media/maintainer-entry-profile.rst        | 208 ++++++++++++++----
 MAINTAINERS                                   |   1 +
 2 files changed, 163 insertions(+), 46 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +5 -5

index ffc712a5f632..dc764163cf1c 100644
@@ -27,19 +27,139 @@ It covers, mainly, the contents of those directories:
 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.
+corresponding API documentation 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
+Due to the size and wide scope of the media subsystem, the media's
+maintainership model is to have committers that have a broad knowledge of
+a specific aspect of the subsystem. It is the committers' 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.
 

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 42

Quoted 8 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -4

-Patches for the media subsystem must be sent to the media mailing list
-at [email protected] 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 committers
+----------------
+
+In the media subsystem, there are experienced developers who can push  

The media subsystem is generally understood to comprise of what's under drivers/media, this should be referring to the community instead.

Quoted 5 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -0

+patches directly to the development tree. These developers are called
+Media committers and are divided into the following categories:
+
+- Committers:

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 56

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+    contributors for one or more drivers within the media subsystem.
+    They can push changes to the tree that do not affect the core or ABI.
+
+- Core committers:
+    responsible for part of the media core. They are typically
+    responsible for one or more drivers within the media subsystem, but, besides
+    that, they can also merge patches that change the code common to multiple
+    drivers, including the kernel internal API.
+
+- Subsystem maintainers:  

s/Subsystem/Media tree/

?

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 61

Quoted 5 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +5 -0

+    responsible for the subsystem as a whole, with access to the
+    entire subsystem.
+
+    Only subsystem maintainers can push changes that affect the userspace
+    API/ABI.  

This is ambiguous. I think it should intend to say API/ABI changes require approval from Media tree maintainers.

What constitutes a UAPI change is a topic of discussion on its own.

Does it
require adding a new IOCTL? Taking into use a reserved field? Changing little-used driver behaviour slightly?

Fixing a bug in a driver?

The first two obviously yes, but the latter two probably not.

Also:

s/Only subsystem maintainers can push/Media tree maintainers' ack is required for/

?

Quoted 14 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +14 -0

+
+All media committers shall explicitly agree with the Kernel development process
+as described at Documentation/process/index.rst and to the Kernel
+development rules inside the Kernel documentation, including its code of
+conduct.
+
+Media development tree
+----------------------
+
+The main development tree used by the media subsystem is hosted at LinuxTV.org,
+where we also maintain news about the subsystem, wiki pages and a patchwork
+instance where we track patches though their lifetime.
+
+The main tree used by media developers is at:

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 85

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+
+https://git.linuxtv.org/media.git/
+
+.. _Media development workflow:
+
+Media development workflow
+++++++++++++++++++++++++++
+
+All changes for the media subsystem must be sent first as e-mails to the
+media mailing list, following the process documented at  

s/^/linux-/

Also I'd refer to it as "LMML".

Quoted 20 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +19 -0

+Documentation/process/index.rst.
+
+It means that patches shall be submitted as plain text only via e-mail to
[email protected]. While subscription is not mandatory, you
+can find details about how to subscribe to it and to see its archives at:
+
+  https://subspace.kernel.org/vger.kernel.org.html
+
+Emails with HTML will be automatically rejected by the mail server.
+
+It could be wise to also copy the media committer(s). You should use
+``scripts/get_maintainers.pl`` to identify whom else needs to be copied.
+Please always copy driver's authors and maintainers.
+
+Such patches need to be based against a public branch or tag as follows:
+
+1. Patches for new features need to be based at the ``next`` branch of
+   media.git tree;
+

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 107

Quoted 3 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -0

+2. Fixes against an already released kernel should preferably be against
+   the latest released Kernel. If they require a previously-applied
+   change at media.git tree, they need to be against its ``fixes`` branch.  

This would be a change to the current process that I don't think has been discussed. If I understand correctly, generally this applies to patches that have been merged to the development branch (formerly media stage tree master) with Cc: stable and Fixes: tags.

Quoted 21 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +21 -0

+
+3. Fixes for issues not present at the latest released kernel shall
+   be either against a -rc kernel for an upcoming release or
+   against the ``fixes`` branch of the media.git tree.
+
+Patches with fixes shall have:
+
+- a ``Fixes:`` tag pointing to the first commit that introduced the bug;
+- when applicable, a ``Cc: [email protected]``.
+
+Patches that were fixing bugs publicly reported by someone at the
[email protected] mailing list shall have:
+
+- a ``Reported-by:`` tag immediately followed by a ``Closes:`` tag.
+
+Patches that change API shall update documentation accordingly at the
+same patch series.
+
+See Documentation/process/index.rst for more details about e-mail submission.
+
+Once a patch is submitted, it may follow either one of the following

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 134

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +6 -0

+workflows:
+
+a. Pull request workflow: patches are handled by subsystem maintainers::
+
+     +------+   +---------+   +-------+   +-----------------------+   +---------+
+     |e-mail|-->|patchwork|-->|pull   |-->|maintainers merge      |-->|media.git|  

s/e-mail/LMML/

(see earlier comment)? Same below.

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 139

Quoted 5 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +5 -0

+     +------+   |picks it |   |request|   |in media-committers.git|   +---------+
+                +---------+   +-------+   +-----------------------+
+
+   For this workflow, pull requests can be generated by a committer,
+   a previous committer, subsystem maintainers or by a trusted long-time  

s/previous/former/

I'd also use plural in all cases here.

Quoted 16 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +14 -0

+   contributor. If you are not in such group, please don't submit  
 
+   pull requests, as they will not be processed.
+
+b. Committers' workflow: patches are handled by media committers::
+
+     +------+   +---------+   +--------------------+   +-----------+   +---------+
+     |e-mail|-->|patchwork|-->|committers merge at |-->|maintainers|-->|media.git|
+     +------+   |picks it |   |media-committers.git|   |approval   |   +---------+
+                +---------+   +--------------------+   +-----------+
+
+On both workflows, all patches shall be properly reviewed at
[email protected] before being merged at media-committers.git.
+
+When patches are picked by patchwork and when merged at media-committers,

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 159

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +6 -0

+CI bots will check for errors and may provide e-mail feedback about
+patch problems. When this happens, the patch submitter must fix them, or
+explain why the errors are false positives.
+
+Patches will only be moved to the next stage in those two workflows if they
+don't fail on CI or if there are false-positives in the CI reports.  

s/don't fail on/pass/

Quoted 56 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -0

+
+Failures during e-mail submission
++++++++++++++++++++++++++++++++++
 
 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

Documentation/driver-api/media/maintainer-entry-profile.rst +21 -12

@@ -47,51 +167,48 @@ 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
+If it doesn't automatically appear there after some time [2]_, 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
+email is in plain text\ [3]_ 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:
+To troubleshoot problems, you should first check if the mailing list
+server has accepted your patch, by looking at:
 
    - https://lore.kernel.org/linux-media/
 
-.. [2] If your email contains HTML, the mailing list server will simply
+If the patch is there and not at patchwork, it is likely that your e-mailer
+mangled the patch. Patchwork internally has a logic that checks if the
+received e-mail contain a valid patch. Any whitespace and new line
+breakages mangling the patch won't be recognized by patchwork, thus such
+patch will be rejected.
+
+.. [2] It usually takes a few minutes for the patch to arrive, but
+       the e-mail server may be busy, so it may take up to a few hours
+       for a patch to be picked by patchwork.
+
+.. [3] If your email contains HTML, the mailing list server will simply
        drop it, without any further notice.
 
+.. _media-developers-gpg:
 
-Media maintainers
-+++++++++++++++++
+Authentication for pull and merge requests
+++++++++++++++++++++++++++++++++++++++++++
 
-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 authenticity of developers submitting pull requests and merge requests
+shall be validated by using PGP sign. See: :ref:`kernel_org_trust_repository`.
 
-The media maintainers that work on specific areas of the subsystem are:
+With the pull request workflow, pull requests shall use a PGP-signed tag.
 

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 204

Quoted 4 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +2 -2

-- Remote Controllers (infrared):
-    Sean Young <[email protected]>
+For more details about PGP sign, please read
+Documentation/process/maintainer-pgp-guide.rst.  

s/.*/:ref:the PGP guide <pgpguide>/

Quoted 65 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -23

-- HDMI CEC:
-    Hans Verkuil <[email protected]>
+Subsystem maintainers
+---------------------
 
-- Media controller drivers:
-    Laurent Pinchart <[email protected]>
-
-- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers:
-    Sakari Ailus <[email protected]>
-
-- V4L2 drivers and core V4L2 frameworks:
-    Hans Verkuil <[email protected]>
-
-The subsystem maintainer is:
-  Mauro Carvalho Chehab <[email protected]>
-
-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.
+The subsystem maintainers are:
+  - Mauro Carvalho Chehab <[email protected]> and
+  - Hans Verkuil <[email protected]>
 
 Submit Checklist Addendum
 -------------------------

@@ -108,17 +225,14 @@ implementing the media APIs:
 ====================	=======================================================
 Type			Tool
 ====================	=======================================================
-V4L2 drivers\ [3]_	``v4l2-compliance``
+V4L2 drivers\ [4]_	``v4l2-compliance``
 V4L2 virtual drivers	``contrib/test/test-media``
 CEC drivers		``cec-compliance``
 ====================	=======================================================
 
-.. [3] The ``v4l2-compliance`` also covers the media controller usage inside
+.. [4] The ``v4l2-compliance`` also covers the media controller usage inside
        V4L2 drivers.
 
-Other compilance tools are under development to check other parts of the
-subsystem.
-
 Those tests need to pass before the patches go upstream.
 
 Also, please notice that we build the Kernel with::

@@ -134,6 +248,8 @@ Where the check script is::
 Be sure to not introduce new warnings on your patches without a
 very good reason.
 
+Please see `Media development workflow`_ for e-mail submission rules.
+
 Style Cleanup Patches
 +++++++++++++++++++++
 

@@ -199,7 +315,7 @@ 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 in a couple of weeks or to ask
-other developers to publicly add Reviewed-by and, more importantly,
+other developers to publicly add ``Reviewed-by:`` and, more importantly,
 ``Tested-by:`` tags.
 

MAINTAINERS MEDIA INPUT INFRASTRUCTURE (V4L/DVB) · line 14516

Quoted 13 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +0 -0

 Please note that we expect a detailed description for ``Tested-by:``,

MAINTAINERS +1 -0

index 1e930c7a58b1..c77f56a2e695 100644
@@ -14510,6 +14510,7 @@ MEDIA INPUT INFRASTRUCTURE (V4L/DVB)
 M:	Mauro Carvalho Chehab <[email protected]>
 L:	[email protected]
 S:	Maintained
+P:	Documentation/driver-api/media/maintainer-entry-profile.rst
 W:	https://linuxtv.org
 Q:	http://patchwork.kernel.org/project/linux-media/list/
 T:	git git://linuxtv.org/media.git  

Em Mon, 2 Dec 2024 12:40:44 +0000
Sakari Ailus <[email protected]> escreveu:

Quoted 40 lines

Hi Mauro,

Thanks for the set.

Looks good overall, please still see my comments below.

Quoted 33 lines · Mauro Carvalho Chehab

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

Reviewed-by Ricardo Ribalda <[email protected]>

---
 .../media/maintainer-entry-profile.rst        | 208 ++++++++++++++----
 MAINTAINERS                                   |   1 +
 2 files changed, 163 insertions(+), 46 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +5 -5

index ffc712a5f632..dc764163cf1c 100644
@@ -27,19 +27,139 @@ It covers, mainly, the contents of those directories:
 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.
+corresponding API documentation 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
+Due to the size and wide scope of the media subsystem, the media's
+maintainership model is to have committers that have a broad knowledge of
+a specific aspect of the subsystem. It is the committers' 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.
 

Quoted 11 lines

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 42

Quoted 8 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -4

-Patches for the media subsystem must be sent to the media mailing list
-at [email protected] 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 committers
+----------------
+
+In the media subsystem, there are experienced developers who can push  

The media subsystem is generally understood to comprise of what's under drivers/media, this should be referring to the community instead.

Do you have a proposal for a different text here?

Quoted 18 lines

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -0

+patches directly to the development tree. These developers are called
+Media committers and are divided into the following categories:
+
+- Committers:

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 56

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+    contributors for one or more drivers within the media subsystem.
+    They can push changes to the tree that do not affect the core or ABI.
+
+- Core committers:
+    responsible for part of the media core. They are typically
+    responsible for one or more drivers within the media subsystem, but, besides
+    that, they can also merge patches that change the code common to multiple
+    drivers, including the kernel internal API.
+
+- Subsystem maintainers:  

s/Subsystem/Media tree/

Here, we're talking specifically about my hole and Hans, which will co-maintain the subsystem with me.. I guess subsystem maintainer is the best to describe it.

Besides that, we used "media maintainers" in the past with a different meaning. Better to not re-use it here.

Quoted 3 lines

?

Quoted 1 line

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -0

+    responsible for the subsystem as a whole, with access to the

Quoted 7 lines

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 61

Quoted 4 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -0

+    entire subsystem.
+
+    Only subsystem maintainers can push changes that affect the userspace
+    API/ABI.  

This is ambiguous. I think it should intend to say API/ABI changes require approval from Media tree maintainers.

At the first moment, the idea is to commit them via PRs. So, no such commits will be merged by committers/core committers, but yeah, it could also be merged directly by a committer if it has our approval.

In any case, such changes need a consensus from the subsystem maintainers, which can just be based on a trust relationship between them with regards to certain parts of the subsystem, or via explicit acks.

Maybe:

API/ABI changes are done via consensus between subsystem maintainers.

Only subsystem maintainers push changes that affect the userspace API/ABI. Committers may push directly if they have approvals from subsystem maintainers.

Quoted 2 lines

What constitutes a UAPI change is a topic of discussion on its own.

Everything that would break backward compatibility with existing non-kernel code are API/ABI changes.

Quoted 3 lines

Does it
require adding a new IOCTL? Taking into use a reserved field? Changing little-used driver behaviour slightly?

For all of those, yes: any changes affecting the behavior or fields/nodes exported via ioctls and sysfs, including new V4L2 controls are API/ABI changes.

Some changes at OF are also API/ABI changes, but those can flow via committers, provided that OF maintainers added their review or acked-by.

Quoted 1 line

Fixing a bug in a driver?

No, fixing a bug, even if related to ABI/API non-compliance aren't.

Yet, ABI/API behavior changes at drivers shall not cause regressions.

I don't think we need to let it clear at the text

Quoted 37 lines

The first two obviously yes, but the latter two probably not.

Also:

s/Only subsystem maintainers can push/Media tree maintainers' ack is required for/

?

Quoted 14 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +14 -0

+
+All media committers shall explicitly agree with the Kernel development process
+as described at Documentation/process/index.rst and to the Kernel
+development rules inside the Kernel documentation, including its code of
+conduct.
+
+Media development tree
+----------------------
+
+The main development tree used by the media subsystem is hosted at LinuxTV.org,
+where we also maintain news about the subsystem, wiki pages and a patchwork
+instance where we track patches though their lifetime.
+
+The main tree used by media developers is at:

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 85

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+
+https://git.linuxtv.org/media.git/
+
+.. _Media development workflow:
+
+Media development workflow
+++++++++++++++++++++++++++
+
+All changes for the media subsystem must be sent first as e-mails to the
+media mailing list, following the process documented at  

s/^/linux-/

Quoted 1 line

Also I'd refer to it as "LMML".

We can add an alias there, but better to be explicit about what mailing list we're referring to.

Quoted 21 lines

Quoted 21 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +19 -0

+Documentation/process/index.rst.
+
+It means that patches shall be submitted as plain text only via e-mail to
[email protected]. While subscription is not mandatory, you
+can find details about how to subscribe to it and to see its archives at:
+
+  https://subspace.kernel.org/vger.kernel.org.html
+
+Emails with HTML will be automatically rejected by the mail server.
+
+It could be wise to also copy the media committer(s). You should use
+``scripts/get_maintainers.pl`` to identify whom else needs to be copied.
+Please always copy driver's authors and maintainers.
+
+Such patches need to be based against a public branch or tag as follows:
+
+1. Patches for new features need to be based at the ``next`` branch of
+   media.git tree;
+

Quoted 8 lines

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 107

Quoted 3 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -0

+2. Fixes against an already released kernel should preferably be against
+   the latest released Kernel. If they require a previously-applied
+   change at media.git tree, they need to be against its ``fixes`` branch.  

This would be a change to the current process that I don't think has been discussed. If I understand correctly, generally this applies to patches that have been merged to the development branch (formerly media stage tree master) with Cc: stable and Fixes: tags.

Not really a change: this is what we do in practice (except that we renamed master to next).

We did discuss that during the LPC week. There was a request there about simplifying the trees during media summit with some suggestions. I did a followup meeting with Hans afterwards for us to check what would work best.

The change is, basically:

	media-tree master -> media.git next
	media-tree fixes   -> media.git fixes

	media-stage master -> media-committers next

Subsystem maintainers are also merging patches at media-committers fixes, in order to let media-ci to test the fixes branch.

As agreed during the media summit, only subsystem maintainers will be merging fixes patches.

Quoted 21 lines

Quoted 21 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +21 -0

+
+3. Fixes for issues not present at the latest released kernel shall
+   be either against a -rc kernel for an upcoming release or
+   against the ``fixes`` branch of the media.git tree.
+
+Patches with fixes shall have:
+
+- a ``Fixes:`` tag pointing to the first commit that introduced the bug;
+- when applicable, a ``Cc: [email protected]``.
+
+Patches that were fixing bugs publicly reported by someone at the
[email protected] mailing list shall have:
+
+- a ``Reported-by:`` tag immediately followed by a ``Closes:`` tag.
+
+Patches that change API shall update documentation accordingly at the
+same patch series.
+
+See Documentation/process/index.rst for more details about e-mail submission.
+
+Once a patch is submitted, it may follow either one of the following

Quoted 8 lines

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 134

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +6 -0

+workflows:
+
+a. Pull request workflow: patches are handled by subsystem maintainers::
+
+     +------+   +---------+   +-------+   +-----------------------+   +---------+
+     |e-mail|-->|patchwork|-->|pull   |-->|maintainers merge      |-->|media.git|  

s/e-mail/LMML/

maybe, instead: e-mail to LMML.

Quoted 9 lines

(see earlier comment)? Same below.

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 139

Quoted 5 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +5 -0

+     +------+   |picks it |   |request|   |in media-committers.git|   +---------+
+                +---------+   +-------+   +-----------------------+
+
+   For this workflow, pull requests can be generated by a committer,
+   a previous committer, subsystem maintainers or by a trusted long-time  

Quoted 3 lines

s/previous/former/

I'd also use plural in all cases here.

Ok.

Quoted 16 lines

Quoted 16 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +14 -0

+   contributor. If you are not in such group, please don't submit  
 
+   pull requests, as they will not be processed.
+
+b. Committers' workflow: patches are handled by media committers::
+
+     +------+   +---------+   +--------------------+   +-----------+   +---------+
+     |e-mail|-->|patchwork|-->|committers merge at |-->|maintainers|-->|media.git|
+     +------+   |picks it |   |media-committers.git|   |approval   |   +---------+
+                +---------+   +--------------------+   +-----------+
+
+On both workflows, all patches shall be properly reviewed at
[email protected] before being merged at media-committers.git.
+
+When patches are picked by patchwork and when merged at media-committers,

Quoted 8 lines

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 159

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +6 -0

+CI bots will check for errors and may provide e-mail feedback about
+patch problems. When this happens, the patch submitter must fix them, or
+explain why the errors are false positives.
+
+Patches will only be moved to the next stage in those two workflows if they
+don't fail on CI or if there are false-positives in the CI reports.  

s/don't fail on/pass/

Ok.

Quoted 56 lines

Quoted 56 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -0

+
+Failures during e-mail submission
++++++++++++++++++++++++++++++++++
 
 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

Documentation/driver-api/media/maintainer-entry-profile.rst +21 -12

@@ -47,51 +167,48 @@ 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
+If it doesn't automatically appear there after some time [2]_, 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
+email is in plain text\ [3]_ 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:
+To troubleshoot problems, you should first check if the mailing list
+server has accepted your patch, by looking at:
 
    - https://lore.kernel.org/linux-media/
 
-.. [2] If your email contains HTML, the mailing list server will simply
+If the patch is there and not at patchwork, it is likely that your e-mailer
+mangled the patch. Patchwork internally has a logic that checks if the
+received e-mail contain a valid patch. Any whitespace and new line
+breakages mangling the patch won't be recognized by patchwork, thus such
+patch will be rejected.
+
+.. [2] It usually takes a few minutes for the patch to arrive, but
+       the e-mail server may be busy, so it may take up to a few hours
+       for a patch to be picked by patchwork.
+
+.. [3] If your email contains HTML, the mailing list server will simply
        drop it, without any further notice.
 
+.. _media-developers-gpg:
 
-Media maintainers
-+++++++++++++++++
+Authentication for pull and merge requests
+++++++++++++++++++++++++++++++++++++++++++
 
-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 authenticity of developers submitting pull requests and merge requests
+shall be validated by using PGP sign. See: :ref:`kernel_org_trust_repository`.
 
-The media maintainers that work on specific areas of the subsystem are:
+With the pull request workflow, pull requests shall use a PGP-signed tag.
 

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 204

Quoted 4 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +2 -2

-- Remote Controllers (infrared):
-    Sean Young <[email protected]>
+For more details about PGP sign, please read
+Documentation/process/maintainer-pgp-guide.rst.  

s/.*/:ref:the PGP guide <pgpguide>/

No need. A Sphinx plugin does that automatically.

Quoted 80 lines

Quoted 79 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -23

-- HDMI CEC:
-    Hans Verkuil <[email protected]>
+Subsystem maintainers
+---------------------
 
-- Media controller drivers:
-    Laurent Pinchart <[email protected]>
-
-- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers:
-    Sakari Ailus <[email protected]>
-
-- V4L2 drivers and core V4L2 frameworks:
-    Hans Verkuil <[email protected]>
-
-The subsystem maintainer is:
-  Mauro Carvalho Chehab <[email protected]>
-
-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.
+The subsystem maintainers are:
+  - Mauro Carvalho Chehab <[email protected]> and
+  - Hans Verkuil <[email protected]>
 
 Submit Checklist Addendum
 -------------------------

@@ -108,17 +225,14 @@ implementing the media APIs:
 ====================	=======================================================
 Type			Tool
 ====================	=======================================================
-V4L2 drivers\ [3]_	``v4l2-compliance``
+V4L2 drivers\ [4]_	``v4l2-compliance``
 V4L2 virtual drivers	``contrib/test/test-media``
 CEC drivers		``cec-compliance``
 ====================	=======================================================
 
-.. [3] The ``v4l2-compliance`` also covers the media controller usage inside
+.. [4] The ``v4l2-compliance`` also covers the media controller usage inside
        V4L2 drivers.
 
-Other compilance tools are under development to check other parts of the
-subsystem.
-
 Those tests need to pass before the patches go upstream.
 
 Also, please notice that we build the Kernel with::

@@ -134,6 +248,8 @@ Where the check script is::
 Be sure to not introduce new warnings on your patches without a
 very good reason.
 
+Please see `Media development workflow`_ for e-mail submission rules.
+
 Style Cleanup Patches
 +++++++++++++++++++++
 

@@ -199,7 +315,7 @@ 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 in a couple of weeks or to ask
-other developers to publicly add Reviewed-by and, more importantly,
+other developers to publicly add ``Reviewed-by:`` and, more importantly,
 ``Tested-by:`` tags.
 
 Please note that we expect a detailed description for ``Tested-by:``,

MAINTAINERS +1 -0

index 1e930c7a58b1..c77f56a2e695 100644
@@ -14510,6 +14510,7 @@ MEDIA INPUT INFRASTRUCTURE (V4L/DVB)
 M:	Mauro Carvalho Chehab <[email protected]>
 L:	[email protected]
 S:	Maintained
+P:	Documentation/driver-api/media/maintainer-entry-profile.rst
 W:	https://linuxtv.org
 Q:	http://patchwork.kernel.org/project/linux-media/list/
 T:	git git://linuxtv.org/media.git  

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

Reviewed-by Ricardo Ribalda <[email protected]>

---
 .../media/maintainer-entry-profile.rst        | 208 ++++++++++++++----
 MAINTAINERS                                   |   1 +
 2 files changed, 163 insertions(+), 46 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +64 -9

index ffc712a5f632..dc764163cf1c 100644
@@ -27,19 +27,139 @@ It covers, mainly, the contents of those directories:
 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.
+corresponding API documentation 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
+Due to the size and wide scope of the media subsystem, the media's
+maintainership model is to have committers that have a broad knowledge of
+a specific aspect of the subsystem. It is the committers' 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 [email protected] 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 committers
+----------------
+
+In the media subsystem, there are experienced developers who can push
+patches directly to the development tree. These developers are called
+Media committers and are divided into the following categories:
+
+- Committers:
+    contributors for one or more drivers within the media subsystem.
+    They can push changes to the tree that do not affect the core or ABI.
+
+- Core committers:
+    responsible for part of the media core. They are typically
+    responsible for one or more drivers within the media subsystem, but, besides
+    that, they can also merge patches that change the code common to multiple
+    drivers, including the kernel internal API.
+
+- Subsystem maintainers:
+    responsible for the subsystem as a whole, with access to the
+    entire subsystem.
+
+    Only subsystem maintainers can push changes that affect the userspace
+    API/ABI.
+
+All media committers shall explicitly agree with the Kernel development process
+as described at Documentation/process/index.rst and to the Kernel
+development rules inside the Kernel documentation, including its code of
+conduct.
+
+Media development tree
+----------------------
+
+The main development tree used by the media subsystem is hosted at LinuxTV.org,
+where we also maintain news about the subsystem, wiki pages and a patchwork
+instance where we track patches though their lifetime.
+
+The main tree used by media developers is at:
+
+https://git.linuxtv.org/media.git/
+
+.. _Media development workflow:
+
+Media development workflow
+++++++++++++++++++++++++++
+
+All changes for the media subsystem must be sent first as e-mails to the
+media mailing list, following the process documented at
+Documentation/process/index.rst.
+
+It means that patches shall be submitted as plain text only via e-mail to
[email protected]. While subscription is not mandatory, you
+can find details about how to subscribe to it and to see its archives at:
+
+  https://subspace.kernel.org/vger.kernel.org.html
+
+Emails with HTML will be automatically rejected by the mail server.
+
+It could be wise to also copy the media committer(s). You should use
+``scripts/get_maintainers.pl`` to identify whom else needs to be copied.

Documentation/driver-api/media/maintainer-entry-profile.rst +53 -2

+
+Patches with fixes shall have:
+
+- a ``Fixes:`` tag pointing to the first commit that introduced the bug;
+- when applicable, a ``Cc: [email protected]``.
+
+Patches that were fixing bugs publicly reported by someone at the
[email protected] mailing list shall have:
+
+- a ``Reported-by:`` tag immediately followed by a ``Closes:`` tag.
+
+Patches that change API shall update documentation accordingly at the
+same patch series.
+
+See Documentation/process/index.rst for more details about e-mail submission.
+
+Once a patch is submitted, it may follow either one of the following
+workflows:
+
+a. Pull request workflow: patches are handled by subsystem maintainers::
+
+     +------+   +---------+   +-------+   +-----------------------+   +---------+
+     |e-mail|-->|patchwork|-->|pull   |-->|maintainers merge      |-->|media.git|
+     +------+   |picks it |   |request|   |in media-committers.git|   +---------+
+                +---------+   +-------+   +-----------------------+
+
+   For this workflow, pull requests can be generated by a committer,
+   a previous committer, subsystem maintainers or by a trusted long-time
+   contributor. If you are not in such group, please don't submit
+   pull requests, as they will not be processed.
+
+b. Committers' workflow: patches are handled by media committers::
+
+     +------+   +---------+   +--------------------+   +-----------+   +---------+
+     |e-mail|-->|patchwork|-->|committers merge at |-->|maintainers|-->|media.git|
+     +------+   |picks it |   |media-committers.git|   |approval   |   +---------+
+                +---------+   +--------------------+   +-----------+
+
+On both workflows, all patches shall be properly reviewed at
[email protected] before being merged at media-committers.git.
+
+When patches are picked by patchwork and when merged at media-committers,
+CI bots will check for errors and may provide e-mail feedback about
+patch problems. When this happens, the patch submitter must fix them, or
+explain why the errors are false positives.
+
+Patches will only be moved to the next stage in those two workflows if they
+don't fail on CI or if there are false-positives in the CI reports.
+
+Failures during e-mail submission
++++++++++++++++++++++++++++++++++
 
 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

@@ -47,51 +167,48 @@ 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
+If it doesn't automatically appear there after some time [2]_, 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
+email is in plain text\ [3]_ only and if your emailer is not mangling
 whitespaces before complaining or submitting them again.

Documentation/driver-api/media/maintainer-entry-profile.rst +9 -2

+breakages mangling the patch won't be recognized by patchwork, thus such
+patch will be rejected.
+
+.. [2] It usually takes a few minutes for the patch to arrive, but
+       the e-mail server may be busy, so it may take up to a few hours
+       for a patch to be picked by patchwork.
+
+.. [3] If your email contains HTML, the mailing list server will simply
        drop it, without any further notice.
 
+.. _media-developers-gpg:
 
-Media maintainers
-+++++++++++++++++

Documentation/driver-api/media/maintainer-entry-profile.rst +8 -20

-The media maintainers that work on specific areas of the subsystem are:
+With the pull request workflow, pull requests shall use a PGP-signed tag.
 
-- Remote Controllers (infrared):
-    Sean Young <[email protected]>
+For more details about PGP sign, please read
+Documentation/process/maintainer-pgp-guide.rst.
 
-- HDMI CEC:
-    Hans Verkuil <[email protected]>
+Subsystem maintainers
+---------------------
 
-- Media controller drivers:
-    Laurent Pinchart <[email protected]>
-
-- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers:
-    Sakari Ailus <[email protected]>
-
-- V4L2 drivers and core V4L2 frameworks:
-    Hans Verkuil <[email protected]>
-
-The subsystem maintainer is:
-  Mauro Carvalho Chehab <[email protected]>
-
-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.
+The subsystem maintainers are:
+  - Mauro Carvalho Chehab <[email protected]> and
+  - Hans Verkuil <[email protected]>
 
 Submit Checklist Addendum
 -------------------------

@@ -108,17 +225,14 @@ implementing the media APIs:
 ====================	=======================================================

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -4

        V4L2 drivers.
 
-Other compilance tools are under development to check other parts of the
-subsystem.
-
 Those tests need to pass before the patches go upstream.
 
 Also, please notice that we build the Kernel with::

@@ -134,6 +248,8 @@ Where the check script is::
 Be sure to not introduce new warnings on your patches without a
 very good reason.
 
+Please see `Media development workflow`_ for e-mail submission rules.
+
 Style Cleanup Patches
 +++++++++++++++++++++
 

@@ -199,7 +315,7 @@ 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 in a couple of weeks or to ask
-other developers to publicly add Reviewed-by and, more importantly,
+other developers to publicly add ``Reviewed-by:`` and, more importantly,
 ``Tested-by:`` tags.
 
 Please note that we expect a detailed description for ``Tested-by:``,

MAINTAINERS +0 -0

index 1e930c7a58b1..c77f56a2e695 100644

Hi Mauro,

Quoted 3 lines · Mauro Carvalho Chehab

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules.

Quoted 2 lines

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

xs4ll.nl -> xs4all.nl

(it's probably my typo, but please fix this in the final version)

Quoted 92 lines

Reviewed-by Ricardo Ribalda <[email protected]>

---
 .../media/maintainer-entry-profile.rst        | 208 ++++++++++++++----
 MAINTAINERS                                   |   1 +
 2 files changed, 163 insertions(+), 46 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +64 -9

index ffc712a5f632..dc764163cf1c 100644
@@ -27,19 +27,139 @@ It covers, mainly, the contents of those directories:
 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.
+corresponding API documentation 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
+Due to the size and wide scope of the media subsystem, the media's
+maintainership model is to have committers that have a broad knowledge of
+a specific aspect of the subsystem. It is the committers' 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 [email protected] 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 committers
+----------------
+
+In the media subsystem, there are experienced developers who can push
+patches directly to the development tree. These developers are called
+Media committers and are divided into the following categories:
+
+- Committers:
+    contributors for one or more drivers within the media subsystem.
+    They can push changes to the tree that do not affect the core or ABI.
+
+- Core committers:
+    responsible for part of the media core. They are typically
+    responsible for one or more drivers within the media subsystem, but, besides
+    that, they can also merge patches that change the code common to multiple
+    drivers, including the kernel internal API.
+
+- Subsystem maintainers:
+    responsible for the subsystem as a whole, with access to the
+    entire subsystem.
+
+    Only subsystem maintainers can push changes that affect the userspace
+    API/ABI.
+
+All media committers shall explicitly agree with the Kernel development process
+as described at Documentation/process/index.rst and to the Kernel
+development rules inside the Kernel documentation, including its code of
+conduct.
+
+Media development tree
+----------------------
+
+The main development tree used by the media subsystem is hosted at LinuxTV.org,
+where we also maintain news about the subsystem, wiki pages and a patchwork
+instance where we track patches though their lifetime.
+
+The main tree used by media developers is at:
+
+https://git.linuxtv.org/media.git/
+
+.. _Media development workflow:
+
+Media development workflow
+++++++++++++++++++++++++++
+
+All changes for the media subsystem must be sent first as e-mails to the
+media mailing list, following the process documented at
+Documentation/process/index.rst.
+
+It means that patches shall be submitted as plain text only via e-mail to
[email protected]. While subscription is not mandatory, you
+can find details about how to subscribe to it and to see its archives at:
+
+  https://subspace.kernel.org/vger.kernel.org.html
+
+Emails with HTML will be automatically rejected by the mail server.
+
+It could be wise to also copy the media committer(s). You should use
+``scripts/get_maintainers.pl`` to identify whom else needs to be copied.

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 107

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+Please always copy driver's authors and maintainers.
+
+Such patches need to be based against a public branch or tag as follows:
+
+1. Patches for new features need to be based at the ``next`` branch of
+   media.git tree;
+
+2. Fixes against an already released kernel should preferably be against
+   the latest released Kernel. If they require a previously-applied
+   change at media.git tree, they need to be against its ``fixes`` branch.  

What is an "released kernel"? Does an -rcX kernel qualify?

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 111

Quoted 4 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -0

+
+3. Fixes for issues not present at the latest released kernel shall
+   be either against a -rc kernel for an upcoming release or
+   against the ``fixes`` branch of the media.git tree.  

2 and 3 remain vague, IMO. Not a blocker, but I think this needs more work at some point.

Quoted 63 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +52 -2

+Patches with fixes shall have:
+
+- a ``Fixes:`` tag pointing to the first commit that introduced the bug;
+- when applicable, a ``Cc: [email protected]``.
+
+Patches that were fixing bugs publicly reported by someone at the
[email protected] mailing list shall have:
+
+- a ``Reported-by:`` tag immediately followed by a ``Closes:`` tag.
+
+Patches that change API shall update documentation accordingly at the
+same patch series.
+
+See Documentation/process/index.rst for more details about e-mail submission.
+
+Once a patch is submitted, it may follow either one of the following
+workflows:
+
+a. Pull request workflow: patches are handled by subsystem maintainers::
+
+     +------+   +---------+   +-------+   +-----------------------+   +---------+
+     |e-mail|-->|patchwork|-->|pull   |-->|maintainers merge      |-->|media.git|
+     +------+   |picks it |   |request|   |in media-committers.git|   +---------+
+                +---------+   +-------+   +-----------------------+
+
+   For this workflow, pull requests can be generated by a committer,
+   a previous committer, subsystem maintainers or by a trusted long-time
+   contributor. If you are not in such group, please don't submit
+   pull requests, as they will not be processed.
+
+b. Committers' workflow: patches are handled by media committers::
+
+     +------+   +---------+   +--------------------+   +-----------+   +---------+
+     |e-mail|-->|patchwork|-->|committers merge at |-->|maintainers|-->|media.git|
+     +------+   |picks it |   |media-committers.git|   |approval   |   +---------+
+                +---------+   +--------------------+   +-----------+
+
+On both workflows, all patches shall be properly reviewed at
[email protected] before being merged at media-committers.git.
+
+When patches are picked by patchwork and when merged at media-committers,
+CI bots will check for errors and may provide e-mail feedback about
+patch problems. When this happens, the patch submitter must fix them, or
+explain why the errors are false positives.
+
+Patches will only be moved to the next stage in those two workflows if they
+don't fail on CI or if there are false-positives in the CI reports.
+
+Failures during e-mail submission
++++++++++++++++++++++++++++++++++
 
 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

@@ -47,51 +167,48 @@ 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
+If it doesn't automatically appear there after some time [2]_, 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
+email is in plain text\ [3]_ only and if your emailer is not mangling
 whitespaces before complaining or submitting them again.

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 181

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -2

 
-You can check if the mailing list server accepted your patch, by looking at:
+To troubleshoot problems, you should first check if the mailing list
+server has accepted your patch, by looking at:
 
    - https://lore.kernel.org/linux-media/
 
-.. [2] If your email contains HTML, the mailing list server will simply
+If the patch is there and not at patchwork, it is likely that your e-mailer
+mangled the patch. Patchwork internally has a logic that checks if the  

a logic -> logic

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 182

Quoted 1 line

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -0

+received e-mail contain a valid patch. Any whitespace and new line  

contain -> contains

Quoted 14 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +9 -2

+breakages mangling the patch won't be recognized by patchwork, thus such
+patch will be rejected.
+
+.. [2] It usually takes a few minutes for the patch to arrive, but
+       the e-mail server may be busy, so it may take up to a few hours
+       for a patch to be picked by patchwork.
+
+.. [3] If your email contains HTML, the mailing list server will simply
        drop it, without any further notice.
 
+.. _media-developers-gpg:
 
-Media maintainers
-+++++++++++++++++

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 199

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -5

+Authentication for pull and merge requests
+++++++++++++++++++++++++++++++++++++++++++
 
-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 authenticity of developers submitting pull requests and merge requests
+shall be validated by using PGP sign. See: :ref:`kernel_org_trust_repository`.  

sign -> signing

Hmm, merge requests through gitlab are not signed. So this isn't correct, I think.

Quoted 46 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +9 -21

-The media maintainers that work on specific areas of the subsystem are:
+With the pull request workflow, pull requests shall use a PGP-signed tag.
 
-- Remote Controllers (infrared):
-    Sean Young <[email protected]>
+For more details about PGP sign, please read
+Documentation/process/maintainer-pgp-guide.rst.
 
-- HDMI CEC:
-    Hans Verkuil <[email protected]>
+Subsystem maintainers
+---------------------
 
-- Media controller drivers:
-    Laurent Pinchart <[email protected]>
-
-- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers:
-    Sakari Ailus <[email protected]>
-
-- V4L2 drivers and core V4L2 frameworks:
-    Hans Verkuil <[email protected]>
-
-The subsystem maintainer is:
-  Mauro Carvalho Chehab <[email protected]>
-
-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.
+The subsystem maintainers are:
+  - Mauro Carvalho Chehab <[email protected]> and
+  - Hans Verkuil <[email protected]>
 
 Submit Checklist Addendum
 -------------------------

@@ -108,17 +225,14 @@ implementing the media APIs:
 ====================	=======================================================
 Type			Tool
 ====================	=======================================================
-V4L2 drivers\ [3]_	``v4l2-compliance``
+V4L2 drivers\ [4]_	``v4l2-compliance``
 V4L2 virtual drivers	``contrib/test/test-media``
 CEC drivers		``cec-compliance``
 ====================	=======================================================
 

Documentation/driver-api/media/maintainer-entry-profile.rst implementing the media APIs: · line 233

Quoted 2 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -1

-.. [3] The ``v4l2-compliance`` also covers the media controller usage inside
+.. [4] The ``v4l2-compliance`` also covers the media controller usage inside  

The ``v4l2-compliance`` utility

(add 'utility')

Quoted 26 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -4

        V4L2 drivers.
 
-Other compilance tools are under development to check other parts of the
-subsystem.
-
 Those tests need to pass before the patches go upstream.
 
 Also, please notice that we build the Kernel with::

@@ -134,6 +248,8 @@ Where the check script is::
 Be sure to not introduce new warnings on your patches without a
 very good reason.
 
+Please see `Media development workflow`_ for e-mail submission rules.
+
 Style Cleanup Patches
 +++++++++++++++++++++
 

@@ -199,7 +315,7 @@ 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 in a couple of weeks or to ask
-other developers to publicly add Reviewed-by and, more importantly,
+other developers to publicly add ``Reviewed-by:`` and, more importantly,
 ``Tested-by:`` tags.
 

MAINTAINERS MEDIA INPUT INFRASTRUCTURE (V4L/DVB) · line 14515

Quoted 12 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +0 -0

 Please note that we expect a detailed description for ``Tested-by:``,

MAINTAINERS +1 -0

index 1e930c7a58b1..c77f56a2e695 100644
@@ -14510,6 +14510,7 @@ MEDIA INPUT INFRASTRUCTURE (V4L/DVB)
 M:	Mauro Carvalho Chehab <[email protected]>
 L:	[email protected]
 S:	Maintained
+P:	Documentation/driver-api/media/maintainer-entry-profile.rst
 W:	https://linuxtv.org
 Q:	http://patchwork.kernel.org/project/linux-media/list/  

Shouldn't this point to our patchwork instance instead?

MAINTAINERS MEDIA INPUT INFRASTRUCTURE (V4L/DVB) · line 14516

Quoted 2 lines

MAINTAINERS +0 -0

 T:	git git://linuxtv.org/media.git  

Regards,

Hans

Em Mon, 2 Dec 2024 14:17:48 +0100
Hans Verkuil <[email protected]> escreveu:

Quoted 6 lines

Hi Mauro,

Quoted 3 lines · Mauro Carvalho Chehab

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules.

Quoted 6 lines

Quoted 2 lines

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

xs4ll.nl -> xs4all.nl

(it's probably my typo, but please fix this in the final version)

Yes, I copied and pasted it. Will fix at the next version.

Quoted 104 lines

Quoted 92 lines

Reviewed-by Ricardo Ribalda <[email protected]>

---
 .../media/maintainer-entry-profile.rst        | 208 ++++++++++++++----
 MAINTAINERS                                   |   1 +
 2 files changed, 163 insertions(+), 46 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +64 -9

index ffc712a5f632..dc764163cf1c 100644
@@ -27,19 +27,139 @@ It covers, mainly, the contents of those directories:
 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.
+corresponding API documentation 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
+Due to the size and wide scope of the media subsystem, the media's
+maintainership model is to have committers that have a broad knowledge of
+a specific aspect of the subsystem. It is the committers' 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 [email protected] 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 committers
+----------------
+
+In the media subsystem, there are experienced developers who can push
+patches directly to the development tree. These developers are called
+Media committers and are divided into the following categories:
+
+- Committers:
+    contributors for one or more drivers within the media subsystem.
+    They can push changes to the tree that do not affect the core or ABI.
+
+- Core committers:
+    responsible for part of the media core. They are typically
+    responsible for one or more drivers within the media subsystem, but, besides
+    that, they can also merge patches that change the code common to multiple
+    drivers, including the kernel internal API.
+
+- Subsystem maintainers:
+    responsible for the subsystem as a whole, with access to the
+    entire subsystem.
+
+    Only subsystem maintainers can push changes that affect the userspace
+    API/ABI.
+
+All media committers shall explicitly agree with the Kernel development process
+as described at Documentation/process/index.rst and to the Kernel
+development rules inside the Kernel documentation, including its code of
+conduct.
+
+Media development tree
+----------------------
+
+The main development tree used by the media subsystem is hosted at LinuxTV.org,
+where we also maintain news about the subsystem, wiki pages and a patchwork
+instance where we track patches though their lifetime.
+
+The main tree used by media developers is at:
+
+https://git.linuxtv.org/media.git/
+
+.. _Media development workflow:
+
+Media development workflow
+++++++++++++++++++++++++++
+
+All changes for the media subsystem must be sent first as e-mails to the
+media mailing list, following the process documented at
+Documentation/process/index.rst.
+
+It means that patches shall be submitted as plain text only via e-mail to
[email protected]. While subscription is not mandatory, you
+can find details about how to subscribe to it and to see its archives at:
+
+  https://subspace.kernel.org/vger.kernel.org.html
+
+Emails with HTML will be automatically rejected by the mail server.
+
+It could be wise to also copy the media committer(s). You should use
+``scripts/get_maintainers.pl`` to identify whom else needs to be copied.

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 107

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+Please always copy driver's authors and maintainers.
+
+Such patches need to be based against a public branch or tag as follows:
+
+1. Patches for new features need to be based at the ``next`` branch of
+   media.git tree;
+
+2. Fixes against an already released kernel should preferably be against
+   the latest released Kernel. If they require a previously-applied
+   change at media.git tree, they need to be against its ``fixes`` branch.  

What is an "released kernel"? Does an -rcX kernel qualify?

Quoted 7 lines

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 111

Quoted 4 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -0

+
+3. Fixes for issues not present at the latest released kernel shall
+   be either against a -rc kernel for an upcoming release or
+   against the ``fixes`` branch of the media.git tree.  

2 and 3 remain vague, IMO. Not a blocker, but I think this needs more work at some point.

Some Kernel documents use "mainline release" to refer to Kernel final releases.

One option to make it clearer would be to add a link to:
https://www.kernel.org/category/releases.html

And then use the terms:
- "Mainline release" for v6.10, v6.11, v6.12...
- "Prepatch release" for -rc1, -rc2, -rc3...

What 2 and means are:

1. Features for the next mainline release:

- baseline shall be media.git ``next`` branch;

2. Fixes bugs at mainline releases:

- baseline shall be the latest mainline release or media.git ``fixes`` if changes depend on a fix already merged;

3. Fixes for the next mainline release:

- baseline shall be a prepatch release or media.git ``fixes`` if changes depend on a fix already merged;

.. Note:

See https://www.kernel.org/category/releases.html for an overview about Kernel release types.

Would the above text work best you? If not please propose another text.

In practice, we'll likely accept other baselines for fixes as well, for practical reasons. From my side, I don't have any issues if I need to rebase a tested bugfix patch produced against an older Kernel send by an occasional contributor, if it only has trivial merge conflicts.

Quoted 108 lines

Quoted 64 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +52 -2

+Patches with fixes shall have:
+
+- a ``Fixes:`` tag pointing to the first commit that introduced the bug;
+- when applicable, a ``Cc: [email protected]``.
+
+Patches that were fixing bugs publicly reported by someone at the
[email protected] mailing list shall have:
+
+- a ``Reported-by:`` tag immediately followed by a ``Closes:`` tag.
+
+Patches that change API shall update documentation accordingly at the
+same patch series.
+
+See Documentation/process/index.rst for more details about e-mail submission.
+
+Once a patch is submitted, it may follow either one of the following
+workflows:
+
+a. Pull request workflow: patches are handled by subsystem maintainers::
+
+     +------+   +---------+   +-------+   +-----------------------+   +---------+
+     |e-mail|-->|patchwork|-->|pull   |-->|maintainers merge      |-->|media.git|
+     +------+   |picks it |   |request|   |in media-committers.git|   +---------+
+                +---------+   +-------+   +-----------------------+
+
+   For this workflow, pull requests can be generated by a committer,
+   a previous committer, subsystem maintainers or by a trusted long-time
+   contributor. If you are not in such group, please don't submit
+   pull requests, as they will not be processed.
+
+b. Committers' workflow: patches are handled by media committers::
+
+     +------+   +---------+   +--------------------+   +-----------+   +---------+
+     |e-mail|-->|patchwork|-->|committers merge at |-->|maintainers|-->|media.git|
+     +------+   |picks it |   |media-committers.git|   |approval   |   +---------+
+                +---------+   +--------------------+   +-----------+
+
+On both workflows, all patches shall be properly reviewed at
[email protected] before being merged at media-committers.git.
+
+When patches are picked by patchwork and when merged at media-committers,
+CI bots will check for errors and may provide e-mail feedback about
+patch problems. When this happens, the patch submitter must fix them, or
+explain why the errors are false positives.
+
+Patches will only be moved to the next stage in those two workflows if they
+don't fail on CI or if there are false-positives in the CI reports.
+
+Failures during e-mail submission
++++++++++++++++++++++++++++++++++
 
 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

@@ -47,51 +167,48 @@ 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
+If it doesn't automatically appear there after some time [2]_, 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
+email is in plain text\ [3]_ only and if your emailer is not mangling
 whitespaces before complaining or submitting them again.

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 181

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -2

 
-You can check if the mailing list server accepted your patch, by looking at:
+To troubleshoot problems, you should first check if the mailing list
+server has accepted your patch, by looking at:
 
    - https://lore.kernel.org/linux-media/
 
-.. [2] If your email contains HTML, the mailing list server will simply
+If the patch is there and not at patchwork, it is likely that your e-mailer
+mangled the patch. Patchwork internally has a logic that checks if the  

a logic -> logic

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 182

Quoted 1 line

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -0

+received e-mail contain a valid patch. Any whitespace and new line  

contain -> contains

Quoted 14 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +9 -2

+breakages mangling the patch won't be recognized by patchwork, thus such
+patch will be rejected.
+
+.. [2] It usually takes a few minutes for the patch to arrive, but
+       the e-mail server may be busy, so it may take up to a few hours
+       for a patch to be picked by patchwork.
+
+.. [3] If your email contains HTML, the mailing list server will simply
        drop it, without any further notice.
 
+.. _media-developers-gpg:
 
-Media maintainers
-+++++++++++++++++

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 199

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -5

+Authentication for pull and merge requests
+++++++++++++++++++++++++++++++++++++++++++
 
-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 authenticity of developers submitting pull requests and merge requests
+shall be validated by using PGP sign. See: :ref:`kernel_org_trust_repository`.  

sign -> signing

Quoted 2 lines

Hmm, merge requests through gitlab are not signed. So this isn't correct, I think.

No, but they are authenticated based on gitlab's user ID. The authentication we'll have is when the new committer sends us an e-mail providing the gitlab's user ID.

See patch 3, as it contains some changes aiming to better explain it. Once it get the same people reviewing that also reviewed 1 and 2, I'll fold it.

Quoted 46 lines

Quoted 46 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +9 -21

-The media maintainers that work on specific areas of the subsystem are:
+With the pull request workflow, pull requests shall use a PGP-signed tag.
 
-- Remote Controllers (infrared):
-    Sean Young <[email protected]>
+For more details about PGP sign, please read
+Documentation/process/maintainer-pgp-guide.rst.
 
-- HDMI CEC:
-    Hans Verkuil <[email protected]>
+Subsystem maintainers
+---------------------
 
-- Media controller drivers:
-    Laurent Pinchart <[email protected]>
-
-- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers:
-    Sakari Ailus <[email protected]>
-
-- V4L2 drivers and core V4L2 frameworks:
-    Hans Verkuil <[email protected]>
-
-The subsystem maintainer is:
-  Mauro Carvalho Chehab <[email protected]>
-
-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.
+The subsystem maintainers are:
+  - Mauro Carvalho Chehab <[email protected]> and
+  - Hans Verkuil <[email protected]>
 
 Submit Checklist Addendum
 -------------------------

@@ -108,17 +225,14 @@ implementing the media APIs:
 ====================	=======================================================
 Type			Tool
 ====================	=======================================================
-V4L2 drivers\ [3]_	``v4l2-compliance``
+V4L2 drivers\ [4]_	``v4l2-compliance``
 V4L2 virtual drivers	``contrib/test/test-media``
 CEC drivers		``cec-compliance``
 ====================	=======================================================
 

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst implementing the media APIs: · line 233

Quoted 2 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -1

-.. [3] The ``v4l2-compliance`` also covers the media controller usage inside
+.. [4] The ``v4l2-compliance`` also covers the media controller usage inside  

The ``v4l2-compliance`` utility

(add 'utility')

Ok.

Quoted 26 lines

Quoted 26 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -4

        V4L2 drivers.
 
-Other compilance tools are under development to check other parts of the
-subsystem.
-
 Those tests need to pass before the patches go upstream.
 
 Also, please notice that we build the Kernel with::

@@ -134,6 +248,8 @@ Where the check script is::
 Be sure to not introduce new warnings on your patches without a
 very good reason.
 
+Please see `Media development workflow`_ for e-mail submission rules.
+
 Style Cleanup Patches
 +++++++++++++++++++++
 

@@ -199,7 +315,7 @@ 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 in a couple of weeks or to ask
-other developers to publicly add Reviewed-by and, more importantly,
+other developers to publicly add ``Reviewed-by:`` and, more importantly,
 ``Tested-by:`` tags.
 

Quoted 14 lines

MAINTAINERS MEDIA INPUT INFRASTRUCTURE (V4L/DVB) · line 14515

Quoted 12 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +0 -0

 Please note that we expect a detailed description for ``Tested-by:``,

MAINTAINERS +1 -0

index 1e930c7a58b1..c77f56a2e695 100644
@@ -14510,6 +14510,7 @@ MEDIA INPUT INFRASTRUCTURE (V4L/DVB)
 M:	Mauro Carvalho Chehab <[email protected]>
 L:	[email protected]
 S:	Maintained
+P:	Documentation/driver-api/media/maintainer-entry-profile.rst
 W:	https://linuxtv.org
 Q:	http://patchwork.kernel.org/project/linux-media/list/  

Shouldn't this point to our patchwork instance instead?

Good catch! I'll update it.

Quoted 2 lines

Quoted 2 lines

MAINTAINERS +0 -0

 T:	git git://linuxtv.org/media.git  

Em Mon, 2 Dec 2024 14:17:48 +0100
Hans Verkuil <[email protected]> escreveu:

Quoted 6 lines

Hi Mauro,

Quoted 3 lines · Mauro Carvalho Chehab

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules.

Quoted 6 lines

Quoted 2 lines

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

xs4ll.nl -> xs4all.nl

(it's probably my typo, but please fix this in the final version)

Yes, I copied and pasted it. Will fix at the next version.

Quoted 104 lines

Quoted 92 lines

Reviewed-by Ricardo Ribalda <[email protected]>

---
 .../media/maintainer-entry-profile.rst        | 208 ++++++++++++++----
 MAINTAINERS                                   |   1 +
 2 files changed, 163 insertions(+), 46 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +64 -9

index ffc712a5f632..dc764163cf1c 100644
@@ -27,19 +27,139 @@ It covers, mainly, the contents of those directories:
 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.
+corresponding API documentation 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
+Due to the size and wide scope of the media subsystem, the media's
+maintainership model is to have committers that have a broad knowledge of
+a specific aspect of the subsystem. It is the committers' 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 [email protected] 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 committers
+----------------
+
+In the media subsystem, there are experienced developers who can push
+patches directly to the development tree. These developers are called
+Media committers and are divided into the following categories:
+
+- Committers:
+    contributors for one or more drivers within the media subsystem.
+    They can push changes to the tree that do not affect the core or ABI.
+
+- Core committers:
+    responsible for part of the media core. They are typically
+    responsible for one or more drivers within the media subsystem, but, besides
+    that, they can also merge patches that change the code common to multiple
+    drivers, including the kernel internal API.
+
+- Subsystem maintainers:
+    responsible for the subsystem as a whole, with access to the
+    entire subsystem.
+
+    Only subsystem maintainers can push changes that affect the userspace
+    API/ABI.
+
+All media committers shall explicitly agree with the Kernel development process
+as described at Documentation/process/index.rst and to the Kernel
+development rules inside the Kernel documentation, including its code of
+conduct.
+
+Media development tree
+----------------------
+
+The main development tree used by the media subsystem is hosted at LinuxTV.org,
+where we also maintain news about the subsystem, wiki pages and a patchwork
+instance where we track patches though their lifetime.
+
+The main tree used by media developers is at:
+
+https://git.linuxtv.org/media.git/
+
+.. _Media development workflow:
+
+Media development workflow
+++++++++++++++++++++++++++
+
+All changes for the media subsystem must be sent first as e-mails to the
+media mailing list, following the process documented at
+Documentation/process/index.rst.
+
+It means that patches shall be submitted as plain text only via e-mail to
[email protected]. While subscription is not mandatory, you
+can find details about how to subscribe to it and to see its archives at:
+
+  https://subspace.kernel.org/vger.kernel.org.html
+
+Emails with HTML will be automatically rejected by the mail server.
+
+It could be wise to also copy the media committer(s). You should use
+``scripts/get_maintainers.pl`` to identify whom else needs to be copied.

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 107

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +10 -0

+Please always copy driver's authors and maintainers.
+
+Such patches need to be based against a public branch or tag as follows:
+
+1. Patches for new features need to be based at the ``next`` branch of
+   media.git tree;
+
+2. Fixes against an already released kernel should preferably be against
+   the latest released Kernel. If they require a previously-applied
+   change at media.git tree, they need to be against its ``fixes`` branch.

What is an "released kernel"? Does an -rcX kernel qualify?

Quoted 7 lines

Documentation/driver-api/media/maintainer-entry-profile.rst It covers, mainly, the contents of those directories: · line 111

Quoted 4 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -0

+
+3. Fixes for issues not present at the latest released kernel shall
+   be either against a -rc kernel for an upcoming release or
+   against the ``fixes`` branch of the media.git tree.

2 and 3 remain vague, IMO. Not a blocker, but I think this needs more work at some point.

Some Kernel documents use "mainline release" to refer to Kernel final releases.

One option to make it clearer would be to add a link to:
https://www.kernel.org/category/releases.html

And then use the terms:
- "Mainline release" for v6.10, v6.11, v6.12...
- "Prepatch release" for -rc1, -rc2, -rc3...

What 2 and means are:

1. Features for the next mainline release:

- baseline shall be media.git ``next`` branch;

2. Fixes bugs at mainline releases:

- baseline shall be the latest mainline release or media.git ``fixes`` if changes depend on a fix already merged;

3. Fixes for the next mainline release:

- baseline shall be a prepatch release or media.git ``fixes``

if changes depend on a fix already merged;

.. Note:

See https://www.kernel.org/category/releases.html for an overview about Kernel release types.

Would the above text work best you? If not please propose another text.

In practice, we'll likely accept other baselines for fixes as well, for practical reasons. From my side, I don't have any issues if I need to rebase a tested bugfix patch produced against an older Kernel send by an occasional contributor, if it only has trivial merge conflicts.

Quoted 107 lines

Quoted 63 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +52 -2

+Patches with fixes shall have:
+
+- a ``Fixes:`` tag pointing to the first commit that introduced the bug;
+- when applicable, a ``Cc: [email protected]``.
+
+Patches that were fixing bugs publicly reported by someone at the
[email protected] mailing list shall have:
+
+- a ``Reported-by:`` tag immediately followed by a ``Closes:`` tag.
+
+Patches that change API shall update documentation accordingly at the
+same patch series.
+
+See Documentation/process/index.rst for more details about e-mail submission.
+
+Once a patch is submitted, it may follow either one of the following
+workflows:
+
+a. Pull request workflow: patches are handled by subsystem maintainers::
+
+     +------+   +---------+   +-------+   +-----------------------+   +---------+
+     |e-mail|-->|patchwork|-->|pull   |-->|maintainers merge      |-->|media.git|
+     +------+   |picks it |   |request|   |in media-committers.git|   +---------+
+                +---------+   +-------+   +-----------------------+
+
+   For this workflow, pull requests can be generated by a committer,
+   a previous committer, subsystem maintainers or by a trusted long-time
+   contributor. If you are not in such group, please don't submit
+   pull requests, as they will not be processed.
+
+b. Committers' workflow: patches are handled by media committers::
+
+     +------+   +---------+   +--------------------+   +-----------+   +---------+
+     |e-mail|-->|patchwork|-->|committers merge at |-->|maintainers|-->|media.git|
+     +------+   |picks it |   |media-committers.git|   |approval   |   +---------+
+                +---------+   +--------------------+   +-----------+
+
+On both workflows, all patches shall be properly reviewed at
[email protected] before being merged at media-committers.git.
+
+When patches are picked by patchwork and when merged at media-committers,
+CI bots will check for errors and may provide e-mail feedback about
+patch problems. When this happens, the patch submitter must fix them, or
+explain why the errors are false positives.
+
+Patches will only be moved to the next stage in those two workflows if they
+don't fail on CI or if there are false-positives in the CI reports.
+
+Failures during e-mail submission
++++++++++++++++++++++++++++++++++
 
 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

@@ -47,51 +167,48 @@ 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
+If it doesn't automatically appear there after some time [2]_, 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
+email is in plain text\ [3]_ only and if your emailer is not mangling
 whitespaces before complaining or submitting them again.

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 181

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -2

 
-You can check if the mailing list server accepted your patch, by looking at:
+To troubleshoot problems, you should first check if the mailing list
+server has accepted your patch, by looking at:
 
    - https://lore.kernel.org/linux-media/
 
-.. [2] If your email contains HTML, the mailing list server will simply
+If the patch is there and not at patchwork, it is likely that your e-mailer
+mangled the patch. Patchwork internally has a logic that checks if the

a logic -> logic

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 182

Quoted 1 line

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -0

+received e-mail contain a valid patch. Any whitespace and new line

contain -> contains

Quoted 14 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +9 -2

+breakages mangling the patch won't be recognized by patchwork, thus such
+patch will be rejected.
+
+.. [2] It usually takes a few minutes for the patch to arrive, but
+       the e-mail server may be busy, so it may take up to a few hours
+       for a patch to be picked by patchwork.
+
+.. [3] If your email contains HTML, the mailing list server will simply
        drop it, without any further notice.
 
+.. _media-developers-gpg:
 
-Media maintainers
-+++++++++++++++++

Documentation/driver-api/media/maintainer-entry-profile.rst server, and, after a while, it should appear at: · line 199

Quoted 10 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +4 -5

+Authentication for pull and merge requests
+++++++++++++++++++++++++++++++++++++++++++
 
-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 authenticity of developers submitting pull requests and merge requests
+shall be validated by using PGP sign. See: :ref:`kernel_org_trust_repository`.

sign -> signing

Quoted 2 lines

Hmm, merge requests through gitlab are not signed. So this isn't correct, I think.

No, but they are authenticated based on gitlab's user ID. The authentication we'll have is when the new committer sends us an e-mail providing the gitlab's user ID.

See patch 3, as it contains some changes aiming to better explain it. Once it get the same people reviewing that also reviewed 1 and 2, I'll fold it.

Quoted 46 lines

Quoted 46 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +9 -21

-The media maintainers that work on specific areas of the subsystem are:
+With the pull request workflow, pull requests shall use a PGP-signed tag.
 
-- Remote Controllers (infrared):
-    Sean Young <[email protected]>
+For more details about PGP sign, please read
+Documentation/process/maintainer-pgp-guide.rst.
 
-- HDMI CEC:
-    Hans Verkuil <[email protected]>
+Subsystem maintainers
+---------------------
 
-- Media controller drivers:
-    Laurent Pinchart <[email protected]>
-
-- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers:
-    Sakari Ailus <[email protected]>
-
-- V4L2 drivers and core V4L2 frameworks:
-    Hans Verkuil <[email protected]>
-
-The subsystem maintainer is:
-  Mauro Carvalho Chehab <[email protected]>
-
-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.
+The subsystem maintainers are:
+  - Mauro Carvalho Chehab <[email protected]> and
+  - Hans Verkuil <[email protected]>
 
 Submit Checklist Addendum
 -------------------------

@@ -108,17 +225,14 @@ implementing the media APIs:
 ====================       =======================================================
 Type                       Tool
 ====================       =======================================================
-V4L2 drivers\ [3]_ ``v4l2-compliance``
+V4L2 drivers\ [4]_ ``v4l2-compliance``
 V4L2 virtual drivers       ``contrib/test/test-media``
 CEC drivers                ``cec-compliance``
 ====================       =======================================================
 

Quoted 6 lines

Documentation/driver-api/media/maintainer-entry-profile.rst implementing the media APIs: · line 233

Quoted 2 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -1

-.. [3] The ``v4l2-compliance`` also covers the media controller usage inside
+.. [4] The ``v4l2-compliance`` also covers the media controller usage inside

The ``v4l2-compliance`` utility

(add 'utility')

Ok.

Quoted 26 lines

Quoted 26 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +3 -4

        V4L2 drivers.
 
-Other compilance tools are under development to check other parts of the
-subsystem.
-
 Those tests need to pass before the patches go upstream.
 
 Also, please notice that we build the Kernel with::

@@ -134,6 +248,8 @@ Where the check script is::
 Be sure to not introduce new warnings on your patches without a
 very good reason.
 
+Please see `Media development workflow`_ for e-mail submission rules.
+
 Style Cleanup Patches
 +++++++++++++++++++++
 

@@ -199,7 +315,7 @@ 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 in a couple of weeks or to ask
-other developers to publicly add Reviewed-by and, more importantly,
+other developers to publicly add ``Reviewed-by:`` and, more importantly,
 ``Tested-by:`` tags.
 

Quoted 14 lines

MAINTAINERS MEDIA INPUT INFRASTRUCTURE (V4L/DVB) · line 14515

Quoted 12 lines

Documentation/driver-api/media/maintainer-entry-profile.rst +0 -0

 Please note that we expect a detailed description for ``Tested-by:``,

MAINTAINERS +1 -0

index 1e930c7a58b1..c77f56a2e695 100644
@@ -14510,6 +14510,7 @@ MEDIA INPUT INFRASTRUCTURE (V4L/DVB)
 M: Mauro Carvalho Chehab <[email protected]>
 L: [email protected]
 S: Maintained
+P: Documentation/driver-api/media/maintainer-entry-profile.rst
 W: https://linuxtv.org
 Q: http://patchwork.kernel.org/project/linux-media/list/

Shouldn't this point to our patchwork instance instead?

Good catch! I'll update it.

Quoted 6 lines

MAINTAINERS MEDIA INPUT INFRASTRUCTURE (V4L/DVB) · line 14516

Quoted 2 lines

MAINTAINERS +0 -0

 T: git git://linuxtv.org/media.git

Regards,

Hans

Thanks,
Mauro

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules, and add a file documenting the process to become a committer and to maintain such rights.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

Reviewed-by Ricardo Ribalda <[email protected]>

---
 Documentation/driver-api/media/index.rst      |   1 +
 .../media/maintainer-entry-profile.rst        |   8 +
 .../driver-api/media/media-committer.rst      | 278 ++++++++++++++++++
 .../process/maintainer-pgp-guide.rst          |   2 +
 4 files changed, 289 insertions(+)
 create mode 100644 Documentation/driver-api/media/media-committer.rst

Documentation/driver-api/media/index.rst +1 -0

index d5593182a3f9..d0c725fcbc67 100644
@@ -26,6 +26,7 @@ Documentation/userspace-api/media/index.rst
     :numbered:
 
     maintainer-entry-profile
+    media-committer
 
     v4l2-core
     dtv-core

Documentation/driver-api/media/maintainer-entry-profile.rst +8 -0

index dc764163cf1c..705209eacf58 100644
@@ -65,6 +65,9 @@ as described at Documentation/process/index.rst and to the Kernel
 development rules inside the Kernel documentation, including its code of
 conduct.
 
+More details about media commiters' roles and responsibilities can be
+found here: Documentation/driver-api/media/media-committer.rst.
+
 Media development tree
 ----------------------
 

@@ -200,6 +203,11 @@ shall be validated by using PGP sign. See: :ref:`kernel_org_trust_repository`.
 
 With the pull request workflow, pull requests shall use a PGP-signed tag.
 
+With the committers' workflow, this is ensured at the time merge request
+rights will be granted to the gitlab instance used by media-committers.git
+tree, after receiving the e-mail documented at
+:ref:`media-committer-agreement`.
+
 For more details about PGP sign, please read
 Documentation/process/maintainer-pgp-guide.rst.
 

Documentation/driver-api/media/media-committer.rst new file +0 -0

new file mode 100644
index 000000000000..3c2f8f413307

Documentation/driver-api/media/media-committer.rst new file +4 -0

+maintainers and the Linux Media community[1].
+
+As such, a media committer is not just someone who is capable of creating
+code, but someone who has demonstrated their ability to collaborate

Documentation/driver-api/media/media-committer.rst new file +8 -0

+whether or not we think you will be good at doing that.
+
+As such, potential committers must earn enough credibility and trust from the
+LinuxTV community. To do that, developers shall be familiar with the open
+source model and have been active in the Linux Kernel community for some time,
+and, in particular, in the media subsystem.
+
+So, in addition to actually making the code changes, you are basically

Documentation/driver-api/media/media-committer.rst new file +65 -0

+
+Due to that, to become a committer or a core committer, a consensus between
+all subsystem maintainers is required, as they all need to trust a developer
+well enough to be delegated the responsibility to maintain part of the code
+and to properly review patches from third parties, in a timely manner and
+keeping the status of the reviewed code at https://patchwork.linuxtv.org
+updated.
+
+.. Note::
+
+   In order to preserve/protect the developers that could have their commit
+   rights granted, denied or removed as well as the subsystem maintainers who
+   have the task to accept or deny commit rights, all communication related to
+   nominating a committer, preserving commit rights or leaving such function
+   should happen in private as much as possible.
+
+.. _media-committer-agreement:
+
+Media committer's agreement
+---------------------------
+
+Once a nominated committer is accepted by all subsystem maintainers,
+they will ask if the developer is interested in the nomination and discuss
+what area(s) of the media subsystem the committer will be responsible for.
+
+Once the developer accepts being a committer, the new committer shall
+explicitly accept the Kernel development policies described under its
+Documentation/, and, in particular to the rules on this document, by writing
+an e-mail to [email protected], with a declaration of intent
+following the model below::
+
+   I, John Doe, would like to change my status to: Committer
+
+   I intend to actively develop the XYZ driver, send fixes to drivers
+   that I can test, optionally reviewing patches and merging trivial
+   fixes in other areas of the subsystem, ...
+
+   For the purpose of committing patches to the media-committer's tree,
+   I'll be using my user https://gitlab.freedesktop.org/users/<username>.
+
+Followed by a formal declaration of agreement with the Kernel development
+rules::
+
+   I hereby declare that I agree with the Kernel development rules described at:
+
+   https://www.kernel.org/doc/html/latest/driver-api/media/media-committer.rst
+
+   and to the Linux Kernel development process rules.
+
+   I agree to the Code of Conduct as documented in:
+   https://www.kernel.org/doc/html/latest/process/code-of-conduct.rst
+
+   I am aware that I can, at any point of time, retire. In that case, I will
+   send an e-mail to notify the subsystem maintainers for them to revoke my
+   commit rights.
+
+   I am aware that the Kernel development rules change over time.
+   By doing a new push to media-commiter tree, I understand that I agree
+   with the rules in effect at the time of the commit.
+
+Such e-mail shall be signed with a PGP key cross signed by other Kernel and
+media developers. As described at :ref:`media-developers-gpg`, the PGP
+signature, together with the gitlab user security are fundamental components
+that ensure the authentity of the merge requests that will happen at the
+media-committer.git tree.

Documentation/driver-api/media/media-committer.rst new file +118 -0

+      the media-committers mailinglist with a reasonable review period. All
+      committers are automatically subscribed to that mailinglist;
+   2. Due to the distributed nature of the Kernel development, it is
+      possible that kernel development process changes may end being
+      reviewed/merged at the linux-docs mailing list, specially for the
+      contents under Documentation/process and for trivial typo fixes.
+
+Core committers
+---------------
+
+As described in Documentation/driver-api/media/maintainer-entry-profile.rst
+a committer may be granted with additional rights to also be able to
+change a core file and/or media subsystem's Kernel API. The extent of
+the core committer's grants will be detailed by the subsystem maintainers
+when they nominate a core committer.
+
+Existing committers may become core committers and vice versa. Such
+decisions will be taken in consensus between the subsystem maintainers.
+
+Media committers rules
+----------------------
+
+Media committers shall do their best efforts to avoid merged patches that
+would break any existing drivers. If it breaks, fixup or revert patches
+shall be merged as soon as possible, aiming to be merged at the same Kernel
+cycle the bug is reported.
+
+Media committers shall behave accordingly to the rights granted by
+the subsystem maintainers, specially with regards of the scope of changes
+they may apply directly at the media-committers tree. Such scope can
+change over time on a mutual agreement between media committers and
+maintainers.
+
+As described at :ref:`Media development workflow`, there are workflows.
+For the committers' workflow, the following rules apply:
+
+- Each merged patch shall pass CI tests;
+
+- Media committers shall request reviews from other committers and
+  developers where applicable, i.e. because those developers have more
+  knowledge about some areas that are changed by a patch;
+
+- There shall be no open issues or unresolved or conflicting feedback
+  from anyone. Clear them up first. Defer to subsystem maintainers as needed.
+
+Patches that do not fall under the committer's workflow criteria will follow
+the pull request workflow as described at :ref:`Media development workflow`.
+
+Only a subsystem maintainer can override such rules.
+
+All media committers shall ensure that patchwork will reflect the current
+status, e.g. patches shall be delegated to the media committer who is
+handling them and the patch status shall be updated according to these rules:
+
+- ``Under review``: Used if the patch requires a second opinion
+  or when it is part of a pull request;
+- ``Accepted``: Once a patch is merged in the multi-committer tree.
+- ``Superseded``: There is a newer version of the patch posted to the
+  mailing list.
+- ``Duplicated``: There was another patch doing the same thing from someone
+  else that was accepted.
+- ``Not Applicable``: Use for patch series that are not merged at media.git
+  tree (e.g. drm, dmabuf, upstream merge, etc.) but were cross-posted to the
+  linux-media mailing list.
+
+If the committer decides not to merge it, then reply by email to patch
+authors, explaining why it is not merged, and patchwork shall be updated
+accordingly with either:
+
+- ``Changes Requested``: if a new revision was requested;
+- ``Rejected``: if the proposed change won't be merged upstream.
+
+If a media committer decides to retire, it is the committer's duty to
+notify the subsystem maintainers about that decision.
+
+.. Note::
+
+   Patchwork supports a couple of clients to help semi-automating
+   status updates via its REST interface:
+
+   https://patchwork.readthedocs.io/en/latest/usage/clients/
+
+Maintaining media committer status
+----------------------------------
+
+A community of committers working together to move the Linux Kernel
+forward is essential to creating successful projects that are rewarding
+to work on. If there are problems or disagreements within the community,
+they can usually be solved through healthy discussion and debate.
+
+In the unhappy event that a media committer continues to disregard good
+citizenship (or actively disrupts the project), we may need to revoke
+that person's status. In such cases, if someone suggests the revocation
+with a good reason, then after discussing this among the media committers,
+the final decision is taken by the subsystem maintainers. As the decision
+to become a media committer comes from a consensus between subsystem
+maintainers, a single subsystem maintainer not trusting the media committer
+anymore is enough to revoke committer's grants.
+
+If a committer is inactive for more than a couple of Kernel cycles,
+maintainers will try to reach you via e-mail. If not possible, they may
+revoke your committer grants and update MAINTAINERS file entries
+accordingly. If you wish to resume contributing later on, then contact
+the subsystem maintainers to ask if your rights can be restored.
+
+A previous committer that had their commit rights revoked can keep
+contributing to the subsystem via the pull request workflow as documented
+at the :ref:`Media development workflow`.
+
+References
+----------
+
+Much of this was inspired by/copied from the committer policies of:
+
+- `Chromium <https://chromium.googlesource.com/chromium/src/+/main/docs/contributing.md>`_;
+- `WebKit <https://webkit.org/commit-and-review-policy/>`_;
+- `Mozilla <https://www.mozilla.org/hacking/committer/>`_.
+

Documentation/process/maintainer-pgp-guide.rst +2 -0

index f5277993b195..795ef8d89271 100644
@@ -903,6 +903,8 @@ the new default in GnuPG v2). To set it, add (or modify) the
 
     trust-model tofu+pgp
 
+.. _kernel_org_trust_repository:
+
 Using the kernel.org web of trust repository
 --------------------------------------------
 

Hi Mauro,

Quoted 60 lines · Mauro Carvalho Chehab

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules, and add a file documenting the process to become a committer and to maintain such rights.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

Reviewed-by Ricardo Ribalda <[email protected]>

---
 Documentation/driver-api/media/index.rst      |   1 +
 .../media/maintainer-entry-profile.rst        |   8 +
 .../driver-api/media/media-committer.rst      | 278 ++++++++++++++++++
 .../process/maintainer-pgp-guide.rst          |   2 +
 4 files changed, 289 insertions(+)
 create mode 100644 Documentation/driver-api/media/media-committer.rst

Documentation/driver-api/media/index.rst +1 -0

index d5593182a3f9..d0c725fcbc67 100644
@@ -26,6 +26,7 @@ Documentation/userspace-api/media/index.rst
     :numbered:
 
     maintainer-entry-profile
+    media-committer
 
     v4l2-core
     dtv-core

Documentation/driver-api/media/maintainer-entry-profile.rst +8 -0

index dc764163cf1c..705209eacf58 100644
@@ -65,6 +65,9 @@ as described at Documentation/process/index.rst and to the Kernel
 development rules inside the Kernel documentation, including its code of
 conduct.
 
+More details about media commiters' roles and responsibilities can be
+found here: Documentation/driver-api/media/media-committer.rst.
+
 Media development tree
 ----------------------
 

@@ -200,6 +203,11 @@ shall be validated by using PGP sign. See: :ref:`kernel_org_trust_repository`.
 
 With the pull request workflow, pull requests shall use a PGP-signed tag.
 
+With the committers' workflow, this is ensured at the time merge request
+rights will be granted to the gitlab instance used by media-committers.git
+tree, after receiving the e-mail documented at
+:ref:`media-committer-agreement`.
+
 For more details about PGP sign, please read
 Documentation/process/maintainer-pgp-guide.rst.
 

Documentation/driver-api/media/media-committer.rst new file +0 -0

new file mode 100644
index 000000000000..3c2f8f413307

Documentation/driver-api/media/media-committer.rst line 4

Quoted 4 lines

Documentation/driver-api/media/media-committer.rst new file +4 -0

@@ -0,0 +1,278 @@
+Media committers
+================
+
+What is a media committer?  

"What" refers to a "thing" but developers generally are humans.

Documentation/driver-api/media/media-committer.rst line 7

Quoted 3 lines

Documentation/driver-api/media/media-committer.rst new file +3 -0

+--------------------------
+
+A media committer is a developer who can push patches from other developers  

s/can/has been granted commit access to/

?

Documentation/driver-api/media/media-committer.rst line 18

Quoted 11 lines

Documentation/driver-api/media/media-committer.rst new file +11 -0

+and their own patches to the
+`media-committers <https://gitlab.freedesktop.org/linux-media/media-committers>`_
+tree.
+
+It is a media committer's duty to ensure that their entries in the MAINTAINERS
+file are kept up-to-date, and that submitted patches for files for which
+they are listed as maintainers are timely reviewed on the mailing list,
+ideally not waiting in patchwork as ``New`` for more than one Kernel merge
+cycle, and, if accepted, applying them at the media committer's tree.
+
+These commit rights are granted with some expectation of responsibility:  

s/some //

Documentation/driver-api/media/media-committer.rst line 20

Quoted 2 lines

Documentation/driver-api/media/media-committer.rst new file +2 -0

+committers are people who care about the Linux Kernel as a whole and
+about the Linux media subsystem and want to help its development. It  

s/help/advance/

?

Documentation/driver-api/media/media-committer.rst line 21

Quoted 2 lines

Documentation/driver-api/media/media-committer.rst new file +1 -0

+is also based on a trust relationship between the rest of the committers,  

s/also//
s/between the rest of/among/

I wonder if we should add here some expectation on being reachable on #linux-media.

Quoted 8 lines

Documentation/driver-api/media/media-committer.rst new file +8 -0

+maintainers and the Linux Media community[1].
+
+As such, a media committer is not just someone who is capable of creating
+code, but someone who has demonstrated their ability to collaborate
+with the team, get the most knowledgeable people to review code,
+contribute high-quality code, and follow through to fix issues (in code
+or tests).
+

Documentation/driver-api/media/media-committer.rst line 35

Quoted 6 lines

Documentation/driver-api/media/media-committer.rst new file +6 -0

+.. Note::
+
+   1. If a patch introduces a regression, then it is the media committer's
+      responsibility to correct that as soon as possible. Typically the
+      patch is either reverted, or an additional patch is committed that
+      fixes the regression;  

s/that fixes/to fix/

Documentation/driver-api/media/media-committer.rst line 38

Quoted 4 lines

Documentation/driver-api/media/media-committer.rst new file +3 -0

+   2. if patches are fixing bugs against already released Kernels, including
+      the reverts above mentioned, the media committer shall add the needed
+      tags. Please see :ref:`Media development workflow` for more details.  

Does this reference work?

Documentation/driver-api/media/media-committer.rst line 47

Quoted 8 lines

Documentation/driver-api/media/media-committer.rst new file +8 -0

+[1] The Linux Media community, also called LinuxTV community, has its primary
+    site at https://linuxtv.org.
+
+Becoming a media committer
+--------------------------
+
+The most important aspect of volunteering to be a committer is that you have
+demonstrated the ability to give good code reviews. So we are looking for  

I wonder if we should add some kind of an expectation of demonstrating common sense? :-)

Quoted 12 lines

Documentation/driver-api/media/media-committer.rst new file +12 -0

+whether or not we think you will be good at doing that.
+
+As such, potential committers must earn enough credibility and trust from the
+LinuxTV community. To do that, developers shall be familiar with the open
+source model and have been active in the Linux Kernel community for some time,
+and, in particular, in the media subsystem.
+
+So, in addition to actually making the code changes, you are basically
+demonstrating your:
+
+- commitment to the project;
+- ability to collaborate with the team and communicate well;

Documentation/driver-api/media/media-committer.rst line 65

Quoted 6 lines

Documentation/driver-api/media/media-committer.rst new file +6 -0

+- understand of how upstream and the LinuxTV community work
+  (policies, processes for testing, code review, ...)
+- reasonable knowledge about:
+
+  - the Kernel development process:
+    Documentation/process/index.rst  

:ref:the Kernel development process <process_index>

Documentation/driver-api/media/media-committer.rst line 68

Quoted 3 lines

Documentation/driver-api/media/media-committer.rst new file +3 -0

+
+  - the Media development profile:
+    Documentation/driver-api/media/maintainer-entry-profile.rst  

Could you add a label to the title and refer to it directly?

Documentation/driver-api/media/media-committer.rst line 75

Quoted 7 lines

Documentation/driver-api/media/media-committer.rst new file +7 -0

+
+- understanding of the projects' code base and coding style;
+- ability to provide feedback to the patch authors;
+- ability to judge when a patch might be ready for review and to submit;
+- ability to write good code (last but certainly not least).
+
+Developers that intend to become committers are encouraged to participate  

s/intend/yearn/

Documentation/driver-api/media/media-committer.rst line 77

Quoted 3 lines

Documentation/driver-api/media/media-committer.rst new file +2 -0

+at the yearly Linux Media Summit, typically co-located with another Linux
+conference.  

s/another Linux/a Linux related/

Documentation/driver-api/media/media-committer.rst line 85

Quoted 8 lines

Documentation/driver-api/media/media-committer.rst new file +8 -0

+
+If you are doing such tasks and have become a valued developer, an
+existing committer can nominate you to the media subsystem maintainers.
+
+The ultimate responsibility for accepting a nominated committer is up to
+the subsystem's maintainers. The committers must earn a trust relationship
+with all subsystem maintainers, as, by granting you commit rights, they will
+be delegating part of their maintenance tasks.  

s/delegating\K/ a/

Quoted 69 lines

Documentation/driver-api/media/media-committer.rst new file +69 -0

+
+Due to that, to become a committer or a core committer, a consensus between
+all subsystem maintainers is required, as they all need to trust a developer
+well enough to be delegated the responsibility to maintain part of the code
+and to properly review patches from third parties, in a timely manner and
+keeping the status of the reviewed code at https://patchwork.linuxtv.org
+updated.
+
+.. Note::
+
+   In order to preserve/protect the developers that could have their commit
+   rights granted, denied or removed as well as the subsystem maintainers who
+   have the task to accept or deny commit rights, all communication related to
+   nominating a committer, preserving commit rights or leaving such function
+   should happen in private as much as possible.
+
+.. _media-committer-agreement:
+
+Media committer's agreement
+---------------------------
+
+Once a nominated committer is accepted by all subsystem maintainers,
+they will ask if the developer is interested in the nomination and discuss
+what area(s) of the media subsystem the committer will be responsible for.
+
+Once the developer accepts being a committer, the new committer shall
+explicitly accept the Kernel development policies described under its
+Documentation/, and, in particular to the rules on this document, by writing
+an e-mail to [email protected], with a declaration of intent
+following the model below::
+
+   I, John Doe, would like to change my status to: Committer
+
+   I intend to actively develop the XYZ driver, send fixes to drivers
+   that I can test, optionally reviewing patches and merging trivial
+   fixes in other areas of the subsystem, ...
+
+   For the purpose of committing patches to the media-committer's tree,
+   I'll be using my user https://gitlab.freedesktop.org/users/<username>.
+
+Followed by a formal declaration of agreement with the Kernel development
+rules::
+
+   I hereby declare that I agree with the Kernel development rules described at:
+
+   https://www.kernel.org/doc/html/latest/driver-api/media/media-committer.rst
+
+   and to the Linux Kernel development process rules.
+
+   I agree to the Code of Conduct as documented in:
+   https://www.kernel.org/doc/html/latest/process/code-of-conduct.rst
+
+   I am aware that I can, at any point of time, retire. In that case, I will
+   send an e-mail to notify the subsystem maintainers for them to revoke my
+   commit rights.
+
+   I am aware that the Kernel development rules change over time.
+   By doing a new push to media-commiter tree, I understand that I agree
+   with the rules in effect at the time of the commit.
+
+Such e-mail shall be signed with a PGP key cross signed by other Kernel and
+media developers. As described at :ref:`media-developers-gpg`, the PGP
+signature, together with the gitlab user security are fundamental components
+that ensure the authentity of the merge requests that will happen at the
+media-committer.git tree.
+
+In case the kernel development process changes, by merging new commits
+in the
+`media-committer tree <https://gitlab.freedesktop.org/linux-media/media-committers>`_,

Documentation/driver-api/media/media-committer.rst line 160

Quoted 6 lines

Documentation/driver-api/media/media-committer.rst new file +6 -0

+the media committer implicitly declares their agreement with the latest
+version of the documented process including the contents of this file.
+
+.. note::
+
+   1. Changes to the kernel media development process should be announced in  

s/should/shall/ ?

Quoted 125 lines

Documentation/driver-api/media/media-committer.rst new file +118 -0

+      the media-committers mailinglist with a reasonable review period. All
+      committers are automatically subscribed to that mailinglist;
+   2. Due to the distributed nature of the Kernel development, it is
+      possible that kernel development process changes may end being
+      reviewed/merged at the linux-docs mailing list, specially for the
+      contents under Documentation/process and for trivial typo fixes.
+
+Core committers
+---------------
+
+As described in Documentation/driver-api/media/maintainer-entry-profile.rst
+a committer may be granted with additional rights to also be able to
+change a core file and/or media subsystem's Kernel API. The extent of
+the core committer's grants will be detailed by the subsystem maintainers
+when they nominate a core committer.
+
+Existing committers may become core committers and vice versa. Such
+decisions will be taken in consensus between the subsystem maintainers.
+
+Media committers rules
+----------------------
+
+Media committers shall do their best efforts to avoid merged patches that
+would break any existing drivers. If it breaks, fixup or revert patches
+shall be merged as soon as possible, aiming to be merged at the same Kernel
+cycle the bug is reported.
+
+Media committers shall behave accordingly to the rights granted by
+the subsystem maintainers, specially with regards of the scope of changes
+they may apply directly at the media-committers tree. Such scope can
+change over time on a mutual agreement between media committers and
+maintainers.
+
+As described at :ref:`Media development workflow`, there are workflows.
+For the committers' workflow, the following rules apply:
+
+- Each merged patch shall pass CI tests;
+
+- Media committers shall request reviews from other committers and
+  developers where applicable, i.e. because those developers have more
+  knowledge about some areas that are changed by a patch;
+
+- There shall be no open issues or unresolved or conflicting feedback
+  from anyone. Clear them up first. Defer to subsystem maintainers as needed.
+
+Patches that do not fall under the committer's workflow criteria will follow
+the pull request workflow as described at :ref:`Media development workflow`.
+
+Only a subsystem maintainer can override such rules.
+
+All media committers shall ensure that patchwork will reflect the current
+status, e.g. patches shall be delegated to the media committer who is
+handling them and the patch status shall be updated according to these rules:
+
+- ``Under review``: Used if the patch requires a second opinion
+  or when it is part of a pull request;
+- ``Accepted``: Once a patch is merged in the multi-committer tree.
+- ``Superseded``: There is a newer version of the patch posted to the
+  mailing list.
+- ``Duplicated``: There was another patch doing the same thing from someone
+  else that was accepted.
+- ``Not Applicable``: Use for patch series that are not merged at media.git
+  tree (e.g. drm, dmabuf, upstream merge, etc.) but were cross-posted to the
+  linux-media mailing list.
+
+If the committer decides not to merge it, then reply by email to patch
+authors, explaining why it is not merged, and patchwork shall be updated
+accordingly with either:
+
+- ``Changes Requested``: if a new revision was requested;
+- ``Rejected``: if the proposed change won't be merged upstream.
+
+If a media committer decides to retire, it is the committer's duty to
+notify the subsystem maintainers about that decision.
+
+.. Note::
+
+   Patchwork supports a couple of clients to help semi-automating
+   status updates via its REST interface:
+
+   https://patchwork.readthedocs.io/en/latest/usage/clients/
+
+Maintaining media committer status
+----------------------------------
+
+A community of committers working together to move the Linux Kernel
+forward is essential to creating successful projects that are rewarding
+to work on. If there are problems or disagreements within the community,
+they can usually be solved through healthy discussion and debate.
+
+In the unhappy event that a media committer continues to disregard good
+citizenship (or actively disrupts the project), we may need to revoke
+that person's status. In such cases, if someone suggests the revocation
+with a good reason, then after discussing this among the media committers,
+the final decision is taken by the subsystem maintainers. As the decision
+to become a media committer comes from a consensus between subsystem
+maintainers, a single subsystem maintainer not trusting the media committer
+anymore is enough to revoke committer's grants.
+
+If a committer is inactive for more than a couple of Kernel cycles,
+maintainers will try to reach you via e-mail. If not possible, they may
+revoke your committer grants and update MAINTAINERS file entries
+accordingly. If you wish to resume contributing later on, then contact
+the subsystem maintainers to ask if your rights can be restored.
+
+A previous committer that had their commit rights revoked can keep
+contributing to the subsystem via the pull request workflow as documented
+at the :ref:`Media development workflow`.
+
+References
+----------
+
+Much of this was inspired by/copied from the committer policies of:
+
+- `Chromium <https://chromium.googlesource.com/chromium/src/+/main/docs/contributing.md>`_;
+- `WebKit <https://webkit.org/commit-and-review-policy/>`_;
+- `Mozilla <https://www.mozilla.org/hacking/committer/>`_.
+

Documentation/process/maintainer-pgp-guide.rst +0 -0

index f5277993b195..795ef8d89271 100644
@@ -903,6 +903,8 @@ the new default in GnuPG v2). To set it, add (or modify) the
 

Documentation/process/maintainer-pgp-guide.rst the new default in GnuPG v2). To set it, add (or modify) the · line 910

Quoted 7 lines

Documentation/process/maintainer-pgp-guide.rst +2 -0

     trust-model tofu+pgp
 
+.. _kernel_org_trust_repository:
+
 Using the kernel.org web of trust repository
 --------------------------------------------
 

Quoted 7 lines

Quoted 1 line

+is also based on a trust relationship between the rest of the committers,

s/also//
s/between the rest of/among/

I wonder if we should add here some expectation on being reachable on #linux-media.

I'll add it at the note about linuxtv.org:

These commit rights are granted with expectation of responsibility:
committers are people who care about the Linux Kernel as a whole and about the Linux media subsystem and want to advance its development. It is also based on a trust relationship among other committers, maintainers and the Linux Media community[1].

...

[1] The Linux Media Community, also called LinuxTV Community, has its primary site at https://linuxtv.org.

Media committers and developers are reachable via the #linux-media IRC channel at OFTC.

Quoted 17 lines

Quoted 5 lines

Documentation/driver-api/media/media-committer.rst new file +4 -0

+maintainers and the Linux Media community[1].
+
+As such, a media committer is not just someone who is capable of creating
+code, but someone who has demonstrated their ability to collaborate

Documentation/driver-api/media/media-committer.rst line 35

Quoted 10 lines

Documentation/driver-api/media/media-committer.rst new file +10 -0

+with the team, get the most knowledgeable people to review code,
+contribute high-quality code, and follow through to fix issues (in code
+or tests).
+
+.. Note::
+
+   1. If a patch introduces a regression, then it is the media committer's
+      responsibility to correct that as soon as possible. Typically the
+      patch is either reverted, or an additional patch is committed that
+      fixes the regression;  

s/that fixes/to fix/

Ok.

Quoted 6 lines

Documentation/driver-api/media/media-committer.rst line 38

Quoted 4 lines

Documentation/driver-api/media/media-committer.rst new file +3 -0

+   2. if patches are fixing bugs against already released Kernels, including
+      the reverts above mentioned, the media committer shall add the needed
+      tags. Please see :ref:`Media development workflow` for more details.  

Does this reference work?

Yes. Tested on Sphinx 6.2.0.

Quoted 11 lines

Documentation/driver-api/media/media-committer.rst line 47

Quoted 8 lines

+[1] The Linux Media community, also called LinuxTV community, has its primary

Documentation/driver-api/media/media-committer.rst new file +7 -0

+    site at https://linuxtv.org.
+
+Becoming a media committer
+--------------------------
+
+The most important aspect of volunteering to be a committer is that you have
+demonstrated the ability to give good code reviews. So we are looking for  

I wonder if we should add some kind of an expectation of demonstrating common sense? :-)

Could you propose some text for that?

Quoted 13 lines

Quoted 13 lines

Documentation/driver-api/media/media-committer.rst new file +12 -0

+whether or not we think you will be good at doing that.
+
+As such, potential committers must earn enough credibility and trust from the
+LinuxTV community. To do that, developers shall be familiar with the open
+source model and have been active in the Linux Kernel community for some time,
+and, in particular, in the media subsystem.
+
+So, in addition to actually making the code changes, you are basically
+demonstrating your:
+
+- commitment to the project;
+- ability to collaborate with the team and communicate well;

Quoted 8 lines

Documentation/driver-api/media/media-committer.rst line 65

Quoted 6 lines

+- understand of how upstream and the LinuxTV community work

Documentation/driver-api/media/media-committer.rst new file +5 -0

+  (policies, processes for testing, code review, ...)
+- reasonable knowledge about:
+
+  - the Kernel development process:
+    Documentation/process/index.rst  

:ref:the Kernel development process <process_index>

No need. a Sphinx converts all *.rst into references automatically.

Better to use RST files at the text, as makes easier for people reading the text file directly.

Quoted 6 lines

Documentation/driver-api/media/media-committer.rst line 68

Quoted 4 lines

Documentation/driver-api/media/media-committer.rst new file +3 -0

+
+  - the Media development profile:
+    Documentation/driver-api/media/maintainer-entry-profile.rst  

Could you add a label to the title and refer to it directly?

Same as above.

Quoted 9 lines

Documentation/driver-api/media/media-committer.rst line 75

Quoted 7 lines

Documentation/driver-api/media/media-committer.rst new file +7 -0

+
+- understanding of the projects' code base and coding style;
+- ability to provide feedback to the patch authors;
+- ability to judge when a patch might be ready for review and to submit;
+- ability to write good code (last but certainly not least).
+
+Developers that intend to become committers are encouraged to participate  

s/intend/yearn/

Heh, I had to go to the dictionary to seek for "yearn" meaning ;-)

Let's use a simpler language, as most developers are not native-English speakers. I did:

s/intend/desire/

which is a synonym.

As the media subsystem will experiment with a multi-committers model, update the Maintainer's entry profile to the new rules, and add a file documenting the process to become a committer and to maintain such rights.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

Signed-off-by Hans Verkuil <[email protected]>

Reviewed-by Ricardo Ribalda <[email protected]>

---
 Documentation/driver-api/media/index.rst      |   1 +
 .../media/maintainer-entry-profile.rst        |   8 +
 .../driver-api/media/media-committer.rst      | 278 ++++++++++++++++++
 .../process/maintainer-pgp-guide.rst          |   2 +
 4 files changed, 289 insertions(+)
 create mode 100644 Documentation/driver-api/media/media-committer.rst

Documentation/driver-api/media/index.rst +1 -0

index d5593182a3f9..d0c725fcbc67 100644
@@ -26,6 +26,7 @@ Documentation/userspace-api/media/index.rst
     :numbered:
 
     maintainer-entry-profile
+    media-committer
 
     v4l2-core
     dtv-core

Documentation/driver-api/media/maintainer-entry-profile.rst +0 -0

index dc764163cf1c..705209eacf58 100644

Documentation/driver-api/media/maintainer-entry-profile.rst +2 -0

+:ref:`media-committer-agreement`.
+
 For more details about PGP sign, please read
 Documentation/process/maintainer-pgp-guide.rst.
 

Documentation/driver-api/media/media-committer.rst new file +41 -0

new file mode 100644
index 000000000000..3c2f8f413307
@@ -0,0 +1,278 @@
+Media committers
+================
+
+What is a media committer?
+--------------------------
+
+A media committer is a developer who can push patches from other developers
+and their own patches to the
+`media-committers <https://gitlab.freedesktop.org/linux-media/media-committers>`_
+tree.
+
+It is a media committer's duty to ensure that their entries in the MAINTAINERS
+file are kept up-to-date, and that submitted patches for files for which
+they are listed as maintainers are timely reviewed on the mailing list,
+ideally not waiting in patchwork as ``New`` for more than one Kernel merge
+cycle, and, if accepted, applying them at the media committer's tree.
+
+These commit rights are granted with some expectation of responsibility:
+committers are people who care about the Linux Kernel as a whole and
+about the Linux media subsystem and want to help its development. It
+is also based on a trust relationship between the rest of the committers,
+maintainers and the Linux Media community[1].
+
+As such, a media committer is not just someone who is capable of creating
+code, but someone who has demonstrated their ability to collaborate
+with the team, get the most knowledgeable people to review code,
+contribute high-quality code, and follow through to fix issues (in code
+or tests).
+
+.. Note::
+
+   1. If a patch introduces a regression, then it is the media committer's
+      responsibility to correct that as soon as possible. Typically the
+      patch is either reverted, or an additional patch is committed that
+      fixes the regression;
+   2. if patches are fixing bugs against already released Kernels, including
+      the reverts above mentioned, the media committer shall add the needed
+      tags. Please see :ref:`Media development workflow` for more details.
+
+[1] The Linux Media community, also called LinuxTV community, has its primary
+    site at https://linuxtv.org.

Documentation/driver-api/media/media-committer.rst new file +38 -0

+source model and have been active in the Linux Kernel community for some time,
+and, in particular, in the media subsystem.
+
+So, in addition to actually making the code changes, you are basically
+demonstrating your:
+
+- commitment to the project;
+- ability to collaborate with the team and communicate well;
+- understand of how upstream and the LinuxTV community work
+  (policies, processes for testing, code review, ...)
+- reasonable knowledge about:
+
+  - the Kernel development process:
+    Documentation/process/index.rst
+
+  - the Media development profile:
+    Documentation/driver-api/media/maintainer-entry-profile.rst
+
+- understanding of the projects' code base and coding style;
+- ability to provide feedback to the patch authors;
+- ability to judge when a patch might be ready for review and to submit;
+- ability to write good code (last but certainly not least).
+
+Developers that intend to become committers are encouraged to participate
+at the yearly Linux Media Summit, typically co-located with another Linux
+conference.
+
+If you are doing such tasks and have become a valued developer, an
+existing committer can nominate you to the media subsystem maintainers.
+
+The ultimate responsibility for accepting a nominated committer is up to
+the subsystem's maintainers. The committers must earn a trust relationship
+with all subsystem maintainers, as, by granting you commit rights, they will
+be delegating part of their maintenance tasks.
+
+Due to that, to become a committer or a core committer, a consensus between
+all subsystem maintainers is required, as they all need to trust a developer
+well enough to be delegated the responsibility to maintain part of the code

Documentation/driver-api/media/media-committer.rst new file +34 -0

+   should happen in private as much as possible.
+
+.. _media-committer-agreement:
+
+Media committer's agreement
+---------------------------
+
+Once a nominated committer is accepted by all subsystem maintainers,
+they will ask if the developer is interested in the nomination and discuss
+what area(s) of the media subsystem the committer will be responsible for.
+
+Once the developer accepts being a committer, the new committer shall
+explicitly accept the Kernel development policies described under its
+Documentation/, and, in particular to the rules on this document, by writing
+an e-mail to [email protected], with a declaration of intent
+following the model below::
+
+   I, John Doe, would like to change my status to: Committer
+
+   I intend to actively develop the XYZ driver, send fixes to drivers
+   that I can test, optionally reviewing patches and merging trivial
+   fixes in other areas of the subsystem, ...
+
+   For the purpose of committing patches to the media-committer's tree,
+   I'll be using my user https://gitlab.freedesktop.org/users/<username>.
+
+Followed by a formal declaration of agreement with the Kernel development
+rules::
+
+   I hereby declare that I agree with the Kernel development rules described at:
+
+   https://www.kernel.org/doc/html/latest/driver-api/media/media-committer.rst
+
+   and to the Linux Kernel development process rules.

Documentation/driver-api/media/media-committer.rst new file +71 -0

+`media-committer tree <https://gitlab.freedesktop.org/linux-media/media-committers>`_,
+the media committer implicitly declares their agreement with the latest
+version of the documented process including the contents of this file.
+
+.. note::
+
+   1. Changes to the kernel media development process should be announced in
+      the media-committers mailinglist with a reasonable review period. All
+      committers are automatically subscribed to that mailinglist;
+   2. Due to the distributed nature of the Kernel development, it is
+      possible that kernel development process changes may end being
+      reviewed/merged at the linux-docs mailing list, specially for the
+      contents under Documentation/process and for trivial typo fixes.
+
+Core committers
+---------------
+
+As described in Documentation/driver-api/media/maintainer-entry-profile.rst
+a committer may be granted with additional rights to also be able to
+change a core file and/or media subsystem's Kernel API. The extent of
+the core committer's grants will be detailed by the subsystem maintainers
+when they nominate a core committer.
+
+Existing committers may become core committers and vice versa. Such
+decisions will be taken in consensus between the subsystem maintainers.
+
+Media committers rules
+----------------------
+
+Media committers shall do their best efforts to avoid merged patches that
+would break any existing drivers. If it breaks, fixup or revert patches
+shall be merged as soon as possible, aiming to be merged at the same Kernel
+cycle the bug is reported.
+
+Media committers shall behave accordingly to the rights granted by
+the subsystem maintainers, specially with regards of the scope of changes
+they may apply directly at the media-committers tree. Such scope can
+change over time on a mutual agreement between media committers and
+maintainers.
+
+As described at :ref:`Media development workflow`, there are workflows.
+For the committers' workflow, the following rules apply:
+
+- Each merged patch shall pass CI tests;
+
+- Media committers shall request reviews from other committers and
+  developers where applicable, i.e. because those developers have more
+  knowledge about some areas that are changed by a patch;
+
+- There shall be no open issues or unresolved or conflicting feedback
+  from anyone. Clear them up first. Defer to subsystem maintainers as needed.
+
+Patches that do not fall under the committer's workflow criteria will follow
+the pull request workflow as described at :ref:`Media development workflow`.
+
+Only a subsystem maintainer can override such rules.
+
+All media committers shall ensure that patchwork will reflect the current
+status, e.g. patches shall be delegated to the media committer who is
+handling them and the patch status shall be updated according to these rules:
+
+- ``Under review``: Used if the patch requires a second opinion
+  or when it is part of a pull request;
+- ``Accepted``: Once a patch is merged in the multi-committer tree.
+- ``Superseded``: There is a newer version of the patch posted to the
+  mailing list.
+- ``Duplicated``: There was another patch doing the same thing from someone
+  else that was accepted.
+- ``Not Applicable``: Use for patch series that are not merged at media.git
+  tree (e.g. drm, dmabuf, upstream merge, etc.) but were cross-posted to the
+  linux-media mailing list.

Documentation/driver-api/media/media-committer.rst new file +14 -0

+
+.. Note::
+
+   Patchwork supports a couple of clients to help semi-automating
+   status updates via its REST interface:
+
+   https://patchwork.readthedocs.io/en/latest/usage/clients/
+
+Maintaining media committer status
+----------------------------------
+
+A community of committers working together to move the Linux Kernel
+forward is essential to creating successful projects that are rewarding
+to work on. If there are problems or disagreements within the community,

Documentation/driver-api/media/media-committer.rst new file +14 -0

+
+A previous committer that had their commit rights revoked can keep
+contributing to the subsystem via the pull request workflow as documented
+at the :ref:`Media development workflow`.
+
+References
+----------
+
+Much of this was inspired by/copied from the committer policies of:
+
+- `Chromium <https://chromium.googlesource.com/chromium/src/+/main/docs/contributing.md>`_;
+- `WebKit <https://webkit.org/commit-and-review-policy/>`_;
+- `Mozilla <https://www.mozilla.org/hacking/committer/>`_.
+

Documentation/process/maintainer-pgp-guide.rst +0 -0

index f5277993b195..795ef8d89271 100644

During the review of the media committes profile, it was noticed that the responsibility for timely review patches was not clear:
such review is expected that all developers listed at MAINTAINERS with the "M:" tag (e.g. "maintainers" on its broad sense).

This is orthogonal of being a media committer or not. Such duty is implied at:

Documentation/admin-guide/reporting-issues.rst

and at the MAINTAINERS header, when it says that even when the status is "odd fixes", the patches will flow in.

So, let make it explicit at the maintainer-entry-profile that maintainers need to do timely reviews.

Also, while right now our focus is on granting committer rights to maintainers, the media-committer model may evolve in the future to accept other committers that don't have such duties.

So, make it clear at the media-committer.rst that the duties related to reviewing patches from others are for the drivers they are maintainers as well.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/driver-api/media/maintainer-entry-profile.rst | 5 +++++
 Documentation/driver-api/media/media-committer.rst          | 6 +++---
 2 files changed, 8 insertions(+), 3 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +0 -0

index 705209eacf58..50568c744129 100644

Documentation/driver-api/media/maintainer-entry-profile.rst +2 -0

+directly at the media-committers tree.
+
 When patches are picked by patchwork and when merged at media-committers,
 CI bots will check for errors and may provide e-mail feedback about
 patch problems. When this happens, the patch submitter must fix them, or

Documentation/driver-api/media/media-committer.rst +0 -0

index 3c2f8f413307..ec81f01db126 100644

During the review of the media committes profile, it was noticed

that the responsibility for timely review patches was not clear:
such review is expected that all developers listed at MAINTAINERS with the "M:" tag (e.g. "maintainers" on its broad sense).

This is orthogonal of being a media committer or not. Such duty is implied at:

Documentation/admin-guide/reporting-issues.rst

and at the MAINTAINERS header, when it says that even when the status is "odd fixes", the patches will flow in.

So, let make it explicit at the maintainer-entry-profile that maintainers need to do timely reviews.

Also, while right now our focus is on granting committer rights to maintainers, the media-committer model may evolve in the future to accept other committers that don't have such duties.

So, make it clear at the media-committer.rst that the duties related to reviewing patches from others are for the drivers they are maintainers as well.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/driver-api/media/maintainer-entry-profile.rst | 5 +++++
 Documentation/driver-api/media/media-committer.rst          | 6 +++---
 2 files changed, 8 insertions(+), 3 deletions(-)

Documentation/driver-api/media/maintainer-entry-profile.rst +0 -0

index 705209eacf58..50568c744129 100644

Documentation/driver-api/media/maintainer-entry-profile.rst +1 -0

+
 When patches are picked by patchwork and when merged at media-committers,
 CI bots will check for errors and may provide e-mail feedback about
 patch problems. When this happens, the patch submitter must fix them, or

Documentation/driver-api/media/media-committer.rst +0 -0

index 3c2f8f413307..ec81f01db126 100644

Documentation/driver-api/media/media-committer.rst +1 -0

+at https://patchwork.linuxtv.org updated.
 
 .. Note::
 

Hi Mauro,

Quoted 1 line · Mauro Carvalho Chehab

During the review of the media committes profile, it was noticed

s/committe\K/r/

Can we expect people listed as maintainers to either send PRs or be media committers? I think this might be eventually the result but I think we're quite far from this currently and I expect things to remain that way in the near future.

Em Mon, 2 Dec 2024 14:48:53 +0000
Sakari Ailus <[email protected]> escreveu:

Quoted 6 lines

Hi Mauro,

Quoted 1 line · Mauro Carvalho Chehab

During the review of the media committes profile, it was noticed

s/committe\K/r/

Addressed this and the other editorial changes.

Quoted 4 lines

Can we expect people listed as maintainers to either send PRs or be media committers? I think this might be eventually the result but I think we're quite far from this currently and I expect things to remain that way in the near future.

Yes, having driver maintainers being committers and sending PRs is what we expect to happen first.

For mid/long-term, once driver maintainers get in board, we may also have other committers for the drivers whose maintainer is also a committer.

Now, having committers for drivers whose maintainer is not a committer doesn't sound a good idea, except if such committer is doing just janitorial work and gets A-B/R-B from the driver maintainer on all patches he merges.

The media subsystem used to have a multi-commiter's model in the past, but things didn't go well on that time, and we had to move to a centralized model.

As the community has evolved, and as there are now new policies in place like CoC, let's experiment with a multi-committers again.

The model we're using was inspired by the DRM multi-committers model. Yet, media subsystem is different on several aspects, so the model is not exactly the same.

The implementation will be in phases. For this phase, the goal is that all committers will be people listed at MAINTAINERS.

On this series,:

patch 1: updates the media maintainer's entry profile and adds the workflow that will be used with the new model. While here, it also adds a missing "P:" tag at the MAINTAINERS file, pointing to it;

patch 2: adds a new document focused at the new maintainers process. Its target is for developers that will be granted with commit rights at the new media-maintainers.git tree. It also contains a reference tag addition to kernel.org PGP chain at process/maintainer-pgp-guide.rst.

patch 3: make documents cleared about maintainership duties.

---

v3:
- added patch 3;
- addressed nits pointed by Ricardo during his review;
- did minor editorial changes to improve Sphinx html output.

v2: I tried to address most of the suggestions where there was an agreement from Laurent's review and further comments. As there were several changes, on separate threads, I could have missed something.

Mauro Carvalho Chehab (3):
docs: media: update maintainer-entry-profile for multi-committers
docs: media: document media multi-committers rules and process
docs: media: profile: make it clearer about maintainership duties

 Documentation/driver-api/media/index.rst      |   1 +
 .../media/maintainer-entry-profile.rst        | 219 +++++++++++---
 .../driver-api/media/media-committer.rst      | 278 ++++++++++++++++++
 .../process/maintainer-pgp-guide.rst          |   2 +
 MAINTAINERS                                   |   1 +
 5 files changed, 456 insertions(+), 45 deletions(-)
 create mode 100644 Documentation/driver-api/media/media-committer.rst

Quoted 20 lines

The media subsystem used to have a multi-commiter's model in the past, but things didn't go well on that time, and we had to move to a centralized model.

As the community has evolved, and as there are now new policies in place like CoC, let's experiment with a multi-committers again.

The model we're using was inspired by the DRM multi-committers model. Yet, media subsystem is different on several aspects, so the model is not exactly the same.

The implementation will be in phases. For this phase, the goal is that all committers will be people listed at MAINTAINERS.

On this series,:

patch 1: updates the media maintainer's entry profile and adds the workflow that will be used with the new model. While here, it also adds a missing "P:" tag at the MAINTAINERS file, pointing to it;

Quoted 7 lines

patch 2: adds a new document focused at the new maintainers process. Its target is for developers that will be granted with commit rights at the new media-maintainers.git tree. It also contains a reference tag addition to kernel.org PGP chain at process/maintainer-pgp-guide.rst.

patch 3: make documents cleared about maintainership duties.

At least from my perspective, v3 is close to being ready and I hope that v4 will be good enough to be merged.

That said, what is missing in all this is that there is nothing here that explains why you would want to become a media committer. It is all very dry stuff, lots of 'shall's, and 'rights' and 'trust' and obligations, but nothing about the satisfaction you get when you get the responsibility of a part of the kernel and being able to guide the development of that area.

It's good enough to get the multi-committer process off the ground, but it definitely needs more work to make it more inviting to become a media committer. Because right now it is as dry as dust.

Em Mon, 2 Dec 2024 16:03:45 +0100 Hans Verkuil escreveu:

Quoted 39 lines · Mauro Carvalho Chehab

Quoted 20 lines

The media subsystem used to have a multi-commiter's model in the past, but things didn't go well on that time, and we had to move to a centralized model.

As the community has evolved, and as there are now new policies in place like CoC, let's experiment with a multi-committers again.

The model we're using was inspired by the DRM multi-committers model. Yet, media subsystem is different on several aspects, so the model is not exactly the same.

The implementation will be in phases. For this phase, the goal is that all committers will be people listed at MAINTAINERS.

On this series,:

patch 1: updates the media maintainer's entry profile and adds the workflow that will be used with the new model. While here, it also adds a missing "P:" tag at the MAINTAINERS file, pointing to it;

Quoted 7 lines

patch 2: adds a new document focused at the new maintainers process. Its target is for developers that will be granted with commit rights at the new media-maintainers.git tree. It also contains a reference tag addition to kernel.org PGP chain at process/maintainer-pgp-guide.rst.

patch 3: make documents cleared about maintainership duties.

At least from my perspective, v3 is close to being ready and I hope that v4 will be good enough to be merged.

That said, what is missing in all this is that there is nothing here that explains why you would want to become a media committer. It is all very dry stuff, lots of 'shall's, and 'rights' and 'trust' and obligations, but nothing about the satisfaction you get when you get the responsibility of a part of the kernel and being able to guide the development of that area.

Quoted 3 lines

It's good enough to get the multi-committer process off the ground, but it definitely needs more work to make it more inviting to become a media committer. Because right now it is as dry as dust.

Agreed. We focused on getting a document describing what it is expected by committers, in order to start with the model. My view is that it works fine for such purpose. I also feel that we're close to the final document.

I'm sending today a v4 addressing the comments since last review.

Once we get people that are already interested and ready to be on board, and we know that the model and infrastructure works properly, we may implement a phase 2 focusing on allowing more committers. For such purpose, we need to document the benefits/satisfaction of becoming a new committer. Depending how it goes, either on phase 2 or on phase 3, we can change the model from invitation-only to volunteer-requests.

Quoted 50 lines

Em Mon, 2 Dec 2024 16:03:45 +0100 Hans Verkuil escreveu:

Quoted 39 lines · Mauro Carvalho Chehab

Quoted 20 lines

The media subsystem used to have a multi-commiter's model in the past, but things didn't go well on that time, and we had to move to a centralized model.

As the community has evolved, and as there are now new policies in place like CoC, let's experiment with a multi-committers again.

The model we're using was inspired by the DRM multi-committers model. Yet, media subsystem is different on several aspects, so the model is not exactly the same.

The implementation will be in phases. For this phase, the goal is that all committers will be people listed at MAINTAINERS.

On this series,:

patch 1: updates the media maintainer's entry profile and adds the workflow that will be used with the new model. While here, it also adds a missing "P:" tag at the MAINTAINERS file, pointing to it;

Quoted 7 lines

patch 2: adds a new document focused at the new maintainers process. Its target is for developers that will be granted with commit rights at the new media-maintainers.git tree. It also contains a reference tag addition to kernel.org PGP chain at process/maintainer-pgp-guide.rst.

patch 3: make documents cleared about maintainership duties.

At least from my perspective, v3 is close to being ready and I hope that v4 will be good enough to be merged.

That said, what is missing in all this is that there is nothing here that explains why you would want to become a media committer. It is all very dry stuff, lots of 'shall's, and 'rights' and 'trust' and obligations, but nothing about the satisfaction you get when you get the responsibility of a part of the kernel and being able to guide the development of that area.

Quoted 3 lines

It's good enough to get the multi-committer process off the ground, but it definitely needs more work to make it more inviting to become a media committer. Because right now it is as dry as dust.

Agreed. We focused on getting a document describing what it is expected by committers, in order to start with the model. My view is that it works fine for such purpose. I also feel that we're close to the final document.

I'm sending today a v4 addressing the comments since last review.