From patchwork Wed Dec 4 13:43:02 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 13893791 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 74DB08827; Wed, 4 Dec 2024 13:43:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733319811; cv=none; b=UQCu0vJrTBXvOr8WwUXLj+BOZAm7Pojsnwpw3ENQL6W8DBkr66lYRylmLd6j1yJL0BhEOHIPGzlL3XTm1NUqeRuoLA3QGXnAsHJtqePETleC1I9GpFI9bpQSdBCh/bcVnA1LJGPN/sZsD1+osCRqdydnol7TLl8/lgKjjOGP9nc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733319811; c=relaxed/simple; bh=R8NnzOD7JNZldivMHQfAB8tX/PLuUz0jZaal8sPcNtU=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=nFlOVJid0mVdBpZNSm2IZDQvz5377KlX8A4tI5zApR3PYT8OTbH/suchDD2lZgBv44p9dpNMoV3g0PqoVBxfGBFL41YDpfAz+QOkx3YodjnrM6RTWAw2tyUnMQ7HSnfV69dEdIubT0k4fIbxn2dMurn+cPD52B8XkSOL6mnQ5PU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=DWaz5Bkn; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="DWaz5Bkn" Received: by smtp.kernel.org (Postfix) with ESMTPSA id D4573C4CED1; Wed, 4 Dec 2024 13:43:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1733319810; bh=R8NnzOD7JNZldivMHQfAB8tX/PLuUz0jZaal8sPcNtU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DWaz5BknugmXJa1L9oLaDxnb2e5o2Z7cGn3bwnI1aZNEg9OATozXbe3OARvF9CXO+ ZmsImDChURizGvV1SwgHqTDiYxA4YBH6U52kmgslhGIolm9Y+wgiW3dQyoD3VyLb7l x40c07+9U5NeodxZfVot30r38bw7WWGnygYcozwEBLhxsdORWYMmauGAte2/7c3Cli C87F1kXGYSf6yHGpbeAaIci/DQf+0zfoTKhjA+TN8F0a3n5h5Xy5sEdF+XanjfKcY4 AaMeG6nf2+SkkVVvcedVzuVcOMFsMGfPIMaSbqh5nI1L89E6AkIykEdRvt7JkFnRvM jqMCMlhPIcuGQ== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1tIpf6-00000004ebt-3HxX; Wed, 04 Dec 2024 14:43:28 +0100 From: Mauro Carvalho Chehab To: linux-media@vger.kernel.org Cc: Mauro Carvalho Chehab , Jonathan Corbet , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, workflows@vger.kernel.org Subject: [PATCH v4 1/5] docs: maintainer-pgp-guide.rst: add a reference for kernel.org sign Date: Wed, 4 Dec 2024 14:43:02 +0100 Message-ID: <8f663390c31d6c0c7acec3f39a4a7bf334a01309.1733319659.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.47.1 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Sender: Mauro Carvalho Chehab The media profile documentation will point to kernel.org sign. Add a link to it. Signed-off-by: Mauro Carvalho Chehab --- Patch resent, as linux-media was not on its Cc list. Documentation/process/maintainer-pgp-guide.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/process/maintainer-pgp-guide.rst b/Documentation/process/maintainer-pgp-guide.rst index f5277993b195..795ef8d89271 100644 --- a/Documentation/process/maintainer-pgp-guide.rst +++ b/Documentation/process/maintainer-pgp-guide.rst @@ -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 -------------------------------------------- From patchwork Tue Dec 3 09:35:47 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 13892053 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E9E0B1E0094; Tue, 3 Dec 2024 09:35:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733218559; cv=none; b=oRMlwmWbSEdhrMXI80zSzstzJZYb4vLdt0K2JOdqIdXqwWi49rNO9WCtOe37bGwu1EwLWWRzl6YHFeZ3SXj/h9/4lFMIl17a6bNh7+Ayut1bChGKCZJkftu2fkj+nJ95Rsn0eB6uJ0Z20sZ8I3K30sVTynr7I/2/zLxP8S7oFJU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733218559; c=relaxed/simple; bh=wXvmqIdeJr1PdTa6o7bwdBZ0Ap/yO2GH03ocAkQ+yHU=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=rw3UEHybJqauUxFEP6jhQ+jSq2HAtRYslHbCyk+7Hk1vLYVXLXRYFG25i9BVHz9Mzg3r66dXY27xuWQYhOJX43NYuOMhV2y0roTq88X12X57J8iuv615a+QWYsY+oZF7oTJHw8ECoog2tXKCofP/azb//wvdiZxA7kME0yTYH/8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=frjZwSud; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="frjZwSud" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 573C2C4CED6; Tue, 3 Dec 2024 09:35:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1733218558; bh=wXvmqIdeJr1PdTa6o7bwdBZ0Ap/yO2GH03ocAkQ+yHU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=frjZwSudFQFlmaSEWvQbMk/6woPPUjYhn1LuIr9o7aC+g99MD0L6SktDknCOIt8Mq KD9tnHh/QGhJy2WH/PvU30GZkhP4pfGye/w6DJF7fokLwo+wcyCX1rDEkTSeYNPBRk MgR+ko2iSaPppdwMgqf0jaA7UbzDkV++XeFKai/UNMsrzmydmGq7Xgj0BSVMTEDo3e 7zGEgHFdDCZPtIyg/pRHUs6CuADm3AdDVslqxGpOiqMZ44VA+J4/LCX+cqCm6Zml+d ujBGCNHzWJvzHNQKGAlUDWwLfoiHzMhaYDenMyuANP17DPFPKjOgqmHGDw4gHdtiix EAqi+pGmuMoYg== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1tIPK0-00000002ZIq-15OM; Tue, 03 Dec 2024 10:35:56 +0100 From: Mauro Carvalho Chehab To: Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, linux-media@vger.kernel.org, Hans Verkuil , Ricardo Ribalda Subject: [PATCH v4 3/5] docs: media: update maintainer-entry-profile for multi-committers Date: Tue, 3 Dec 2024 10:35:47 +0100 Message-ID: <5eed1e4a37d087f401b7bd54b793ea301e511d7e.1733218348.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.47.1 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Sender: 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 Signed-off-by: Hans Verkuil Reviewed-by: Ricardo Ribalda --- .../media/maintainer-entry-profile.rst | 241 ++++++++++++++---- 1 file changed, 189 insertions(+), 52 deletions(-) diff --git a/Documentation/driver-api/media/maintainer-entry-profile.rst b/Documentation/driver-api/media/maintainer-entry-profile.rst index ffc712a5f632..101f6df6374f 100644 --- a/Documentation/driver-api/media/maintainer-entry-profile.rst +++ b/Documentation/driver-api/media/maintainer-entry-profile.rst @@ -4,11 +4,12 @@ Media Subsystem Profile Overview -------- -The media subsystem covers support for a variety of devices: stream -capture, analog and digital TV streams, cameras, remote controllers, HDMI CEC -and media pipeline control. +The Linux Media Community (aka: the LinuxTV Community) covers support for a +variety of devices: stream capture, analog and digital TV streams, cameras, +remote controllers, HDMI CEC and media pipeline control. -It covers, mainly, the contents of those directories: +They consist of developers who work with the Linux Kernel media subsystem, +which covers, mainly, the contents of those directories: - drivers/media - drivers/staging/media @@ -27,19 +28,158 @@ 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 linux-media@vger.kernel.org as plain text only e-mail. Emails with -HTML will be automatically rejected by the mail server. It could be wise -to also copy the sub-maintainer(s). +Media 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. + + API/ABI changes are done via consensus between subsystem maintainers\ [2]_. + + Only subsystem maintainers push changes that affect the userspace + API/ABI. Committers may push ABI/API changes on their commits if they + have approvals from subsystem maintainers. + +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. + +.. [2] Everything that would break backward compatibility with existing + non-kernel code are API/ABI changes. This includes ioctl and sysfs + interfaces, v4l2 controls, and their behaviors. + +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 +linux-media@vger.kernel.org (aka: LMML). 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. + +To minimize the chance of merge conflicts for your patch series, and make +easier to backport patches to stable Kernels, we recommend that you use the +following baseline for your patch series: + +1. Features for the next mainline release: + + - baseline shall be media.git ``next`` branch; + +2. Bug fixes for the current mainline release: + + - baseline shall be the latest mainline release or media.git ``fixes`` + if changes depend on a fix already merged; + +3. Bug fixes for the next mainline release: + + - baseline shall be a prepatch release (-rcX) or media.git ``fixes`` + if changes depend on a fix already merged. It is also + fine to use media.git ``next`` as baseline for such patches if such + patches apply cleanly on ``fixes``. + +.. Note:: + + See https://www.kernel.org/category/releases.html for an overview + about Kernel release types. + +Patches with fixes shall have: + +- a ``Fixes:`` tag pointing to the first commit that introduced the bug; +- when applicable, a ``Cc: stable@vger.kernel.org``. + +Patches that were fixing bugs publicly reported by someone at the +linux-media@vger.kernel.org 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| + |to LMML| |picks it | |request| |in media-committers.git| +---------+ + +-------+ +---------+ +-------+ +-----------------------+ + + For this workflow, pull requests can be generated by committers, + former committers, subsystem maintainers or by trusted long-time + contributors. 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| + |to LMML| |picks it | |media-committers.git| |approval | +---------+ + +-------+ +---------+ +--------------------+ +-----------+ + +On both workflows, all patches shall be properly reviewed at +linux-media@vger.kernel.org (LMML) 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 +pass 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 +187,49 @@ 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 [3]_, 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\ [4]_ 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 logic that checks if the +received e-mail contains a valid patch. Any whitespace and new line +breakages mangling the patch won't be recognized by patchwork, thus such +patch will be rejected. + +.. [3] 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. + +.. [4] 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 signing at some moment. +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 PGP-signed tags. -- Remote Controllers (infrared): - Sean Young +For more details about PGP sign, please read +Documentation/process/maintainer-pgp-guide.rst. -- HDMI CEC: - Hans Verkuil +Subsystem maintainers +--------------------- -- Media controller drivers: - Laurent Pinchart - -- ISP, v4l2-async, v4l2-fwnode, v4l2-flash-led-class and Sensor drivers: - Sakari Ailus - -- V4L2 drivers and core V4L2 frameworks: - Hans Verkuil - -The subsystem maintainer is: - Mauro Carvalho Chehab - -Media maintainers may delegate a patch to other media maintainers as needed. -On such case, checkpatch's ``delegate`` field indicates who's currently -responsible for reviewing a patch. +The subsystem maintainers are: + - Mauro Carvalho Chehab and + - Hans Verkuil Submit Checklist Addendum ------------------------- @@ -106,18 +244,15 @@ that should be used in order to check if the drivers are properly implementing the media APIs: ==================== ======================================================= -Type Tool +Type Utility ==================== ======================================================= -V4L2 drivers\ [3]_ ``v4l2-compliance`` +V4L2 drivers\ [5]_ ``v4l2-compliance`` V4L2 virtual drivers ``contrib/test/test-media`` CEC drivers ``cec-compliance`` ==================== ======================================================= -.. [3] 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. +.. [5] The ``v4l2-compliance`` utility also covers the media controller usage + inside V4L2 drivers. Those tests need to pass before the patches go upstream. @@ -134,6 +269,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 +336,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:``, From patchwork Tue Dec 3 09:35:48 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 13892054 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E9E751E0095; Tue, 3 Dec 2024 09:35:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733218559; cv=none; b=BB8MC/ULNM2LHe2nsQHqtXfxyyGrp4+5bk2UCA94AEJz6SNvlM25H5IjpVq648FH8CTIb5AbCygbTNeXI44JuZXwnj7My6vmZgCtMCR0gw1ehsx7OZxkL+ZruyxGHnUbRLZBeC+kPwpY/Wnalw3h5Cef3T/rtvDPNv7+nysHsgo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733218559; c=relaxed/simple; bh=V4Z6HGmrdwYhJVTXKljPZagedqAM2RqxYQjxvhk2oqQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=PNSVflWoIx0ntnL4TycJcEN3HvTnTJ1Ex3Y0Ik0vbOjq/CeNb769hwuL3JJhZ++UAzYqeXeG0siS+9fBmz9FNihtEEn4XIETGYWFMXuUSaEFkwddrvSME7uoRgb7sbyiSXXRARDooKL+5Egl6VIQpXXBqPJnvX54eFjne72voMg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=fl2Kt1Fl; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="fl2Kt1Fl" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 574AFC4AF0B; Tue, 3 Dec 2024 09:35:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1733218558; bh=V4Z6HGmrdwYhJVTXKljPZagedqAM2RqxYQjxvhk2oqQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fl2Kt1FlOCBaTuXrSGblUGnG53vn73OiqJvhXPYRcdTe1nfqUKVoCFZBZJKErRyQ1 htGCXzP7apvwFLfEb0T5mcr1EMk4ZKMGKm9GmlfG7HaFRYq1gFVMWV6YvsVIO6mh5A WngchRnjxv6/ONfwdH6wSge+2pQaUR0cnmlHgwq5CT6Yq+YMHD1HGig8zbUrb7Sch0 V/ir1nq9MtJeehIWD208UqDjnaFfxrswmvy8r9WYNaMmRCle1aa1hEdnzecJpUOwlD XsrnTrACebAefZQTm/KqjBZlJr8mHOKzzDQ37KTuFB2wBCr2dxnYFGCDZdmkbsZxCA hGaaLBStDRbKA== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1tIPK0-00000002ZIu-1CAD; Tue, 03 Dec 2024 10:35:56 +0100 From: Mauro Carvalho Chehab To: Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, linux-media@vger.kernel.org, Hans Verkuil , Ricardo Ribalda Subject: [PATCH v4 4/5] docs: media: document media multi-committers rules and process Date: Tue, 3 Dec 2024 10:35:48 +0100 Message-ID: <01acc93fd8780265ea55772ba793f3f09a43ffa7.1733218348.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.47.1 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Sender: 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 Signed-off-by: Hans Verkuil Reviewed-by: Ricardo Ribalda --- Documentation/driver-api/media/index.rst | 1 + .../media/maintainer-entry-profile.rst | 8 + .../driver-api/media/media-committer.rst | 280 ++++++++++++++++++ 3 files changed, 289 insertions(+) create mode 100644 Documentation/driver-api/media/media-committer.rst diff --git a/Documentation/driver-api/media/index.rst b/Documentation/driver-api/media/index.rst index d5593182a3f9..d0c725fcbc67 100644 --- a/Documentation/driver-api/media/index.rst +++ b/Documentation/driver-api/media/index.rst @@ -26,6 +26,7 @@ Documentation/userspace-api/media/index.rst :numbered: maintainer-entry-profile + media-committer v4l2-core dtv-core diff --git a/Documentation/driver-api/media/maintainer-entry-profile.rst b/Documentation/driver-api/media/maintainer-entry-profile.rst index 101f6df6374f..fa28059f7b3f 100644 --- a/Documentation/driver-api/media/maintainer-entry-profile.rst +++ b/Documentation/driver-api/media/maintainer-entry-profile.rst @@ -69,6 +69,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. + .. [2] Everything that would break backward compatibility with existing non-kernel code are API/ABI changes. This includes ioctl and sysfs interfaces, v4l2 controls, and their behaviors. @@ -221,6 +224,11 @@ See: :ref:`kernel_org_trust_repository`. With the pull request workflow, pull requests shall use PGP-signed tags. +With the committers' workflow, this is ensured at the time merge request +rights will be granted to the gitlab instance used by the media-committers.git +tree, after receiving the e-mail documented in +:ref:`media-committer-agreement`. + For more details about PGP sign, please read Documentation/process/maintainer-pgp-guide.rst. diff --git a/Documentation/driver-api/media/media-committer.rst b/Documentation/driver-api/media/media-committer.rst new file mode 100644 index 000000000000..3d0987a8a93b --- /dev/null +++ b/Documentation/driver-api/media/media-committer.rst @@ -0,0 +1,280 @@ +Media committers +================ + +Who is a media committer? +------------------------- + +A media committer is a developer who has been granted commit access to push +patches from other developers and their own patches to the +`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 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]. + +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 to + fix 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. + + Media committers and developers are reachable via the #linux-media + IRC channel at OFTC. + +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 +whether or not we think you will be good at doing that. + +As such, potential committers must earn enough credibility and trust from the +Linux Media 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; +- understand of how upstream and the Linux Media 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 desire to become committers are encouraged to participate +at the yearly Linux Media Summit, typically co-located with a Linux related +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 a 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 +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 + changing commit rights 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 media-committers@linuxtv.org, 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/. + +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-committer tree, I understand that I agree + with the rules in effect at the time of the commit. + +That 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 authenticity of the merge requests that will happen at the +media-committer.git tree. + +In case the kernel development process changes, by merging new commits +to the +`media-committer tree `_, +the media committer implicitly declares their agreement with the latest +version of the documented process including the contents of this file. + +If a media committer decides to retire, it is the committer's duty to +notify the subsystem maintainers about that decision. + +.. note:: + + 1. Changes to the kernel media development process shall 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. + +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. + +.. 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 the commit rights. + +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 rights and update MAINTAINERS file entries +accordingly. If you wish to resume contributing later on, then contact +the subsystem maintainers to ask if your commit 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 `_; +- `WebKit `_; +- `Mozilla `_. + From patchwork Tue Dec 3 09:35:49 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 13892052 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 79E4D1DFE07; Tue, 3 Dec 2024 09:35:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733218558; cv=none; b=NhfsayW4WzOpIU5rp5hjzA03WdVN9FPk4LvRqAlMMeoxu7SINlvJnAKT6DAQ21pK5xNdSPwEInBlsVvbIuvGPGleCu1CcljEox6Kiq31uPKUWKfj3pHx5I5wC0Mmug+hZexccVonpERRcz1cF5xUxHIqWIl0QkuDDDHXTFU5pMA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1733218558; c=relaxed/simple; bh=a8DOKAbHHk3Uoi98wRsfxUMOehnt2Xr/DWBiY9unq5Y=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=IwY3b8o606m1YZvLD9YyVM0Y+qD4l1llI7syE2dcF1I9fKkpzlPjbgwKHSuHMRs9Mg4CUq6ink4bORtWztRi0e/yDDvj0HXc2nqxhOgUmEqjGkDzc7NG56FSlIlOH+JFWVoA1D98AM1ioGK2NZXHlIwsot1bGnQJNzcVF0mX3rw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=OzByEBuA; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="OzByEBuA" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 57363C4CECF; Tue, 3 Dec 2024 09:35:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1733218558; bh=a8DOKAbHHk3Uoi98wRsfxUMOehnt2Xr/DWBiY9unq5Y=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=OzByEBuA1gRLIgTyuFUtUbv0qEFmB80uw6hlvCRr3MhMD6+ZyG3TgVRh/o6PuzwV6 UWibBdDCqGCdNXAe+hIbRC/cVQ3QBFfeQV/jRoXccKqhPzxR7XbqQhz4RYPRmZDBkX qjhEFyxw54dL4pJVMPs9jPU0p8SuBBjwOUH75Uy7jrvNGkoaKypIATHY9D1Mt2hLKm 9jjlq8nI4YM0lZPILcJTJOZmF4TDBh33+LG0xVUotEqjXI/RVwE0MD9yrQX6qooDOp Uqyh43eCQb+ysJnyfyzT2aO20mKLn8lnDyogjjlkdQD01PRtwZ5jR97Fn1cU7sav1W 8Z98W45LVRvVQ== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1tIPK0-00000002ZIy-1Is6; Tue, 03 Dec 2024 10:35:56 +0100 From: Mauro Carvalho Chehab To: Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, linux-media@vger.kernel.org Subject: [PATCH v4 5/5] docs: media: profile: make it clearer about maintainership duties Date: Tue, 3 Dec 2024 10:35:49 +0100 Message-ID: X-Mailer: git-send-email 2.47.1 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Sender: Mauro Carvalho Chehab During the review of the media committer's 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 Reviewed-by: Ricardo Ribalda Reviewed-by: Hans Verkuil --- Documentation/driver-api/media/maintainer-entry-profile.rst | 5 +++++ Documentation/driver-api/media/media-committer.rst | 6 +++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Documentation/driver-api/media/maintainer-entry-profile.rst b/Documentation/driver-api/media/maintainer-entry-profile.rst index fa28059f7b3f..87b71f89b1df 100644 --- a/Documentation/driver-api/media/maintainer-entry-profile.rst +++ b/Documentation/driver-api/media/maintainer-entry-profile.rst @@ -173,6 +173,11 @@ b. Committers' workflow: patches are handled by media committers:: On both workflows, all patches shall be properly reviewed at linux-media@vger.kernel.org (LMML) before being merged at media-committers.git. +Such patches will be reviewed timely by the maintainers and reviewers as +listed in the MAINTAINERS file. The subsystem maintainers will follow one of +the above workflows, e. g. they will either send a pull request or merge +patches 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 diff --git a/Documentation/driver-api/media/media-committer.rst b/Documentation/driver-api/media/media-committer.rst index 3d0987a8a93b..0bc038a0fdcc 100644 --- a/Documentation/driver-api/media/media-committer.rst +++ b/Documentation/driver-api/media/media-committer.rst @@ -90,9 +90,9 @@ be a 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 -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. +and to properly review patches from third parties for the drivers that they +maintain in a timely manner and keeping the status of the patches at +https://patchwork.linuxtv.org updated. .. Note::