From: Greg KH <gregkh@linuxfoundation.org>
To: Jakub Kicinski <kuba@kernel.org>
Cc: corbet@lwn.net, workflows@vger.kernel.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH docs] docs: maintainer: document expectations of small time maintainers
Date: Sat, 15 Jul 2023 08:38:10 +0200 [thread overview]
Message-ID: <2023071542-startup-everyone-eb5d@gregkh> (raw)
In-Reply-To: <20230713223432.1501133-1-kuba@kernel.org>
On Thu, Jul 13, 2023 at 03:34:32PM -0700, Jakub Kicinski wrote:
> We appear to have a gap in our process docs. We go into detail
> on how to contribute code to the kernel, and how to be a subsystem
> maintainer. I can't find any docs directed towards the thousands
> of small scale maintainers, like folks maintaining a single driver
> or a single network protocol.
>
> Document our expectations and best practices. I'm hoping this doc
> will be particularly useful to set expectations with HW vendors.
>
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
> Please consider this more of a draft than a statement of my opinion.
> IOW prefer suggesting edits over arguing about correctness, hope
> that makes sense.
This looks great to me, thanks for putting it together.
But I do have one objection on the timeline portion:
> ---
> .../feature-and-driver-maintainers.rst | 159 ++++++++++++++++++
> Documentation/maintainer/index.rst | 1 +
> 2 files changed, 160 insertions(+)
> create mode 100644 Documentation/maintainer/feature-and-driver-maintainers.rst
>
> diff --git a/Documentation/maintainer/feature-and-driver-maintainers.rst b/Documentation/maintainer/feature-and-driver-maintainers.rst
> new file mode 100644
> index 000000000000..ee8ccc22b16a
> --- /dev/null
> +++ b/Documentation/maintainer/feature-and-driver-maintainers.rst
> @@ -0,0 +1,159 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==============================
> +Feature and driver maintainers
> +==============================
> +
> +The term "maintainer" spans a very wide range of levels of engagement
> +from people handling patches and pull requests as almost a full time job
> +to people responsible for a small feature or a driver.
> +
> +Unlike most of the chapter, this section is meant for the latter (more
> +populous) group. It provides tips and describes the expectations and
> +responsibilities of maintainers of a small(ish) section of the code.
> +
> +Driver and alike most often do not have their own mailing lists and
> +git trees but instead send and review patches on the list of a larger
> +subsystem.
> +
> +Responsibilities
> +================
> +
> +The amount of maintenance work is usually proportional to the size
> +and popularity of the code base. Small features and drivers should
> +require relatively small amount of care and feeding. Nonetheless
> +when the work does arrive (in form of patches which need review,
> +user bug reports etc.) it has to be acted upon very promptly.
> +Even when single driver only sees one patch a month, or a quarter,
> +a subsystem could well have a hundred such drivers. Subsystem
> +maintainers cannot afford to wait a long time to hear from reviewers.
> +
> +The exact expectations on the review time will vary by subsystem
> +from 1 day (e.g. networking) to a week in smaller subsystems.
"to a few weeks".
I can't do 1 day, or even 1 week for the subsystems I maintain
(especially during merge windows or vacations.) How about that line
being:
from 1 day (e.g. networking) to a few weeks for smaller subsystems.
And then add a link to "For specific subsystem response times, please
see the document in [insert link here to where we keep the subsystem
expectations]"
And yeah, I do need to go add some process/maintainer-* files for the
subsystems I maintain, it might be a good idea to also say that any new
subsystems also provide this so we can start catching up on that.
thanks,
greg k-h
prev parent reply other threads:[~2023-07-15 6:38 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-13 22:34 [PATCH docs] docs: maintainer: document expectations of small time maintainers Jakub Kicinski
2023-07-14 4:36 ` Krzysztof Kozlowski
2023-07-14 5:05 ` Matthew Wilcox
2023-07-14 17:10 ` Jakub Kicinski
2023-07-15 10:31 ` Linux regression tracking (Thorsten Leemhuis)
2023-07-17 7:49 ` Krzysztof Kozlowski
2023-07-17 14:37 ` Greg KH
2023-07-18 15:37 ` Jakub Kicinski
2023-07-18 16:02 ` Thorsten Leemhuis
2023-07-17 7:44 ` Krzysztof Kozlowski
2023-07-14 6:24 ` Thorsten Leemhuis
2023-07-14 17:22 ` Jakub Kicinski
2023-07-14 17:59 ` Mark Brown
2023-07-14 18:34 ` Jakub Kicinski
2023-07-14 20:02 ` Mark Brown
2023-07-15 6:38 ` Greg KH [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2023071542-startup-everyone-eb5d@gregkh \
--to=gregkh@linuxfoundation.org \
--cc=corbet@lwn.net \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.