From patchwork Fri Aug 4 16:25:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Darrick J. Wong" X-Patchwork-Id: 13342096 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2F561C41513 for ; Fri, 4 Aug 2023 16:25:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230184AbjHDQZb (ORCPT ); Fri, 4 Aug 2023 12:25:31 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40550 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230043AbjHDQZ1 (ORCPT ); Fri, 4 Aug 2023 12:25:27 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7B1744C03; Fri, 4 Aug 2023 09:25:05 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 0730F6209E; Fri, 4 Aug 2023 16:25:05 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 5F98EC433C8; Fri, 4 Aug 2023 16:25:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1691166304; bh=I7qvxvL8P/mw7kRzyfLpmDWdMeHsU7ozC37mIPfjykc=; h=Subject:From:To:Cc:Date:In-Reply-To:References:From; b=H6Jo+MVed8qy1PVHJI15N2IC2E3ZoTOHlV6SYBuQBvm7LLqZyfH/xA4yBvVi4Y5YQ TKPqveuyXTY5TNpFurGUimA4mfaLyZP2/hLtKDRjZc0n+TCnRlcOLx2z39lv4EeKps MHMo+881WSyoOT6cGWxTOUqS7D3pxQfIMDuf6ee/lTbMd7P+vuzrvKGkz/FOEKsddT lr/hPmx+8lake3QR7a2RJhe9/RHZk58eOLCFOCwGj/6JA06kpCzs/Z+Zfd0wEFAvo7 A8z1lGATvNXC3eS15nbo5qWhp+U9HftxluDWeCqF0LsDAj+uSjsRZliDj0UIQIBVjF SKuKqE6lYWlGQ== Subject: [PATCH 1/3] docs: add maintainer entry profile for XFS From: "Darrick J. Wong" To: djwong@kernel.org Cc: corbet@lwn.net, Chandan Babu R , linux-xfs@vger.kernel.org, linux-fsdevel@vger.kernel.org, david@fromorbit.com, cem@kernel.org, sandeen@sandeen.net, chandan.babu@oracle.com, amir73il@gmail.com, leah.rumancik@gmail.com, zlang@kernel.org, fstests@vger.kernel.org, willy@infradead.org, shirley.ma@oracle.com, konrad.wilk@oracle.com Date: Fri, 04 Aug 2023 09:25:03 -0700 Message-ID: <169116630379.3243794.7476300844644954184.stgit@frogsfrogsfrogs> In-Reply-To: <169116629797.3243794.7024231508559123519.stgit@frogsfrogsfrogs> References: <169116629797.3243794.7024231508559123519.stgit@frogsfrogsfrogs> User-Agent: StGit/0.19 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org From: Darrick J. Wong Create a new document to list what I think are (within the scope of XFS) our shared goals and community roles. Since I will be stepping down shortly, I feel it's important to write down somewhere all the hats that I have been wearing for the past six years. Also, document important extra details about how to contribute to XFS. Cc: corbet@lwn.net Signed-off-by: Darrick J. Wong Reviewed-by: Chandan Babu R --- Documentation/filesystems/index.rst | 1 .../filesystems/xfs-maintainer-entry-profile.rst | 194 ++++++++++++++++++++ .../maintainer/maintainer-entry-profile.rst | 1 MAINTAINERS | 1 4 files changed, 197 insertions(+) create mode 100644 Documentation/filesystems/xfs-maintainer-entry-profile.rst diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index eb252fc972aa..09cade7eaefc 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -122,6 +122,7 @@ Documentation for filesystem implementations. virtiofs vfat xfs-delayed-logging-design + xfs-maintainer-entry-profile xfs-self-describing-metadata xfs-online-fsck-design zonefs diff --git a/Documentation/filesystems/xfs-maintainer-entry-profile.rst b/Documentation/filesystems/xfs-maintainer-entry-profile.rst new file mode 100644 index 000000000000..32b6ac4ca9d6 --- /dev/null +++ b/Documentation/filesystems/xfs-maintainer-entry-profile.rst @@ -0,0 +1,194 @@ +XFS Maintainer Entry Profile +============================ + +Overview +-------- +XFS is a well known high-performance filesystem in the Linux kernel. +The aim of this project is to provide and maintain a robust and +performant filesystem. + +Patches are generally merged to the for-next branch of the appropriate +git repository. +After a testing period, the for-next branch is merged to the master +branch. + +Kernel code are merged to the xfs-linux tree[0]. +Userspace code are merged to the xfsprogs tree[1]. +Test cases are merged to the xfstests tree[2]. +Ondisk format documentation are merged to the xfs-documentation tree[3]. + +All patchsets involving XFS *must* be cc'd in their entirety to the mailing +list linux-xfs@vger.kernel.org. + +Roles +----- +There are eight key roles in the XFS project. +A person can take on multiple roles, and a role can be filled by +multiple people. +Anyone taking on a role is advised to check in with themselves and +others on a regular basis about burnout. + +- **Outside Contributor**: Anyone who sends a patch but is not involved + in the XFS project on a regular basis. + These folks are usually people who work on other filesystems or + elsewhere in the kernel community. + +- **Developer**: Someone who is familiar with the XFS codebase enough to + write new code, documentation, and tests. + + Developers can often be found in the IRC channel mentioned by the ``C:`` + entry in the kernel MAINTAINERS file. + +- **Senior Developer**: A developer who is very familiar with at least + some part of the XFS codebase and/or other subsystems in the kernel. + These people collectively decide the long term goals of the project + and nudge the community in that direction. + They should help prioritize development and review work for each release + cycle. + + Senior developers tend to be more active participants in the IRC channel. + +- **Reviewer**: Someone (most likely also a developer) who reads code + submissions to decide: + + 0. Is the idea behind the contribution sound? + 1. Does the idea fit the goals of the project? + 2. Is the contribution designed correctly? + 3. Is the contribution polished? + 4. Can the contribution be tested effectively? + + Reviewers should identify themselves with an ``R:`` entry in the kernel + and fstests MAINTAINERS files. + +- **Testing Lead**: This person is responsible for setting the test + coverage goals of the project, negotiating with developers to decide + on new tests for new features, and making sure that developers and + release managers execute on the testing. + + The testing lead should identify themselves with an ``M:`` entry in + the XFS section of the fstests MAINTAINERS file. + +- **Bug Triager**: Someone who examines incoming bug reports in just + enough detail to identify the person to whom the report should be + forwarded. + + The bug triagers should identify themselves with a ``B:`` entry in + the kernel MAINTAINERS file. + +- **Release Manager**: This person merges reviewed patchsets into an + integration branch, tests the result locally, pushes the branch to a + public git repository, and sends pull requests further upstream. + The release manager is not expected to work on new feature patchsets. + If a developer and a reviewer fail to reach a resolution on some point, + the release manager must have the ability to intervene to try to drive a + resolution. + + The release manager should identify themselves with an ``M:`` entry in + the kernel MAINTAINERS file. + +- **Community Manager**: This person calls and moderates meetings of as many + XFS participants as they can get when mailing list discussions prove + insufficient for collective decisionmaking. + They may also serve as liaison between managers of the organizations + sponsoring work on any part of XFS. + +- **LTS Maintainer**: Someone who backports and tests bug fixes from + uptream to the LTS kernels. + There tend to be six separate LTS trees at any given time. + + The maintainer for a given LTS release should identify themselves with an + ``M:`` entry in the MAINTAINERS file for that LTS tree. + Unmaintained LTS kernels should be marked with status ``S: Orphan`` in that + same file. + +Submission Checklist Addendum +----------------------------- +Please follow these additional rules when submitting to XFS: + +- Patches affecting only the filesystem itself should be based against + the latest -rc or the for-next branch. + These patches will be merged back to the for-next branch. + +- Authors of patches touching other subsystems need to coordinate with + the maintainers of XFS and the relevant subsystems to decide how to + proceed with a merge. + +- Any patchset changing XFS should be cc'd in its entirety to linux-xfs. + Do not send partial patchsets; that makes analysis of the broader + context of the changes unnecessarily difficult. + +- Anyone making kernel changes that have corresponding changes to the + userspace utilities should send the userspace changes as separate + patchsets immediately after the kernel patchsets. + +- Authors of bug fix patches are expected to use fstests[2] to perform + an A/B test of the patch to determine that there are no regressions. + When possible, a new regression test case should be written for + fstests. + +- Authors of new feature patchsets must ensure that fstests will have + appropriate functional and input corner-case test cases for the new + feature. + +- When implementing a new feature, it is strongly suggested that the + developers write a design document to answer the following questions: + + * **What** problem is this trying to solve? + + * **Who** will benefit from this solution, and **where** will they + access it? + + * **How** will this new feature work? This should touch on major data + structures and algorithms supporting the solution at a higher level + than code comments. + + * **What** userspace interfaces are necessary to build off of the new + features? + + * **How** will this work be tested to ensure that it solves the + problems laid out in the design document without causing new + problems? + + The design document should be committed in the kernel documentation + directory. + It may be omitted if the feature is already well known to the + community. + +- Patchsets for the new tests should be submitted as separate patchsets + immediately after the kernel and userspace code patchsets. + +- Changes to the on-disk format of XFS must be described in the ondisk + format document[3] and submitted as a patchset after the fstests + patchsets. + +- Patchsets implementing bug fixes and further code cleanups should put + the bug fixes at the beginning of the series to ease backporting. + +Key Release Cycle Dates +----------------------- +Bug fixes may be sent at any time, though the release manager may decide to +defer a patch when the next merge window is close. + +Code submissions targeting the next merge window should be sent between +-rc1 and -rc6. +This gives the community time to review the changes, to suggest other changes, +and for the author to retest those changes. + +Code submissions also requiring changes to fs/iomap and targeting the +next merge window should be sent between -rc1 and -rc4. +This allows the broader kernel community adequate time to test the +infrastructure changes. + +Review Cadence +-------------- +In general, please wait at least one week before pinging for feedback. +To find reviewers, either consult the MAINTAINERS file, or ask +developers that have Reviewed-by tags for XFS changes to take a look and +offer their opinion. + +References +---------- +| [0] https://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git/ +| [1] https://git.kernel.org/pub/scm/fs/xfs/xfsprogs-dev.git/ +| [2] https://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git/ +| [3] https://git.kernel.org/pub/scm/fs/xfs/xfs-documentation.git/ diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst index cfd37f31077f..6b64072d4bf2 100644 --- a/Documentation/maintainer/maintainer-entry-profile.rst +++ b/Documentation/maintainer/maintainer-entry-profile.rst @@ -105,3 +105,4 @@ to do something different in the near future. ../driver-api/media/maintainer-entry-profile ../driver-api/vfio-pci-device-specific-driver-acceptance ../nvme/feature-and-quirk-policy + ../filesystems/xfs-maintainer-entry-profile diff --git a/MAINTAINERS b/MAINTAINERS index d516295978a4..d232e9e36b87 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -23330,6 +23330,7 @@ S: Supported W: http://xfs.org/ C: irc://irc.oftc.net/xfs T: git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git +P: Documentation/filesystems/xfs-maintainer-entry-profile.rst F: Documentation/ABI/testing/sysfs-fs-xfs F: Documentation/admin-guide/xfs.rst F: Documentation/filesystems/xfs-delayed-logging-design.rst From patchwork Fri Aug 4 16:25:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Darrick J. Wong" X-Patchwork-Id: 13342095 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 47C28C04FDF for ; Fri, 4 Aug 2023 16:25:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230208AbjHDQZd (ORCPT ); Fri, 4 Aug 2023 12:25:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40566 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230132AbjHDQZ3 (ORCPT ); Fri, 4 Aug 2023 12:25:29 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 32AEE49E8; Fri, 4 Aug 2023 09:25:11 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id C4D57620AA; Fri, 4 Aug 2023 16:25:10 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 2AD5AC433C8; Fri, 4 Aug 2023 16:25:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1691166310; bh=5F0E7SS1sZXdbK1ReiEDmMbcCn9yNveqdAAt78Ozz38=; h=Subject:From:To:Cc:Date:In-Reply-To:References:From; b=X+YiyIfYuHrGPxSSywpQ+H+/X251omeaTJEp3nIDVn+/1jRxaWdXD/m7xlFWMoORD fCikS+AQ7gfLg5NMOY8fiekmFKJ+wTFeSV2h3k/yQZKMRNOUB/FXLBF613JlXoCo6G gS5X5Sjp4gXAUu5cMzMGtBPagOIO9svn/Uuogl/D09WP1yqlkrG/9AdDMRs99zLr81 E4gKfGIw9B20NSpWz/hX6aLyDAFvLFGAjC7IEXhbEFaf8q6tM5c331enNonvnfqMBr pJsjtZAypEmgUJg4aD4fguUku7PKeBjAhREhX2SVp1JNPvO5CpxewceSC5M6i+tiFl +8R13w5wo/oaQ== Subject: [PATCH 2/3] MAINTAINERS: drop me as XFS maintainer From: "Darrick J. Wong" To: djwong@kernel.org Cc: linux-xfs@vger.kernel.org, linux-fsdevel@vger.kernel.org, david@fromorbit.com, cem@kernel.org, sandeen@sandeen.net, chandan.babu@oracle.com, amir73il@gmail.com, leah.rumancik@gmail.com, zlang@kernel.org, fstests@vger.kernel.org, willy@infradead.org, shirley.ma@oracle.com, konrad.wilk@oracle.com Date: Fri, 04 Aug 2023 09:25:09 -0700 Message-ID: <169116630956.3243794.12991534530388405660.stgit@frogsfrogsfrogs> In-Reply-To: <169116629797.3243794.7024231508559123519.stgit@frogsfrogsfrogs> References: <169116629797.3243794.7024231508559123519.stgit@frogsfrogsfrogs> User-Agent: StGit/0.19 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org From: Darrick J. Wong I burned out years ago trying to juggle the roles senior developer, reviewer, tester, triager (crappily), release manager, and (at times) manager liaison. There's enough work here in this one subsystem for a team of 20 FT, but instead we're squeezed to half that. I thought if I could hold on just a bit longer I could help to maintain the focus on long term development to improve the experience for users. I was wrong. Nowadays, people working on XFS seem to spend most of their time on distro kernel backports and dealing with AI-generated corner case bug reports that aren't user reports. Reviewing has become a nightmare of sifting through under-documented kernel code trying to decide if this new feature won't break all the other features. Getting reviews is an unpleasant process of negotiating with demands for further cleanups, trying to figure out if a review comment is based in experience or unfamiliarity, and wondering if the silence means anything. For now, I will continue to review patches and will try to get online fsck, parent pointers, and realtime volume modernisation merged. Signed-off-by: Darrick J. Wong --- MAINTAINERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MAINTAINERS b/MAINTAINERS index d232e9e36b87..d6b82aac42a4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -23324,7 +23324,7 @@ F: include/xen/arm/swiotlb-xen.h F: include/xen/swiotlb-xen.h XFS FILESYSTEM -M: Darrick J. Wong +R: Darrick J. Wong L: linux-xfs@vger.kernel.org S: Supported W: http://xfs.org/ From patchwork Fri Aug 4 16:25:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Darrick J. Wong" X-Patchwork-Id: 13342097 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 56D51C05052 for ; Fri, 4 Aug 2023 16:25:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230224AbjHDQZe (ORCPT ); Fri, 4 Aug 2023 12:25:34 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40656 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230155AbjHDQZ3 (ORCPT ); Fri, 4 Aug 2023 12:25:29 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E024749CB; Fri, 4 Aug 2023 09:25:16 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 7E414620A3; Fri, 4 Aug 2023 16:25:16 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id DE123C433C7; Fri, 4 Aug 2023 16:25:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1691166315; bh=6HyVwGgg0hQ242V38jdl3lmrTJewR5sqxSV03aSXNhc=; h=Subject:From:To:Cc:Date:In-Reply-To:References:From; b=fyuO7nqJ5hZY7rxrVI9zOn1iMGi5KG7nOhmgYjM10ZFd5s/6tkNzzdFdcefYp7W1r d/zKiV+FA0J8nhLZPD4Mhki5v5CdHYvxlAmk9vo4B3oktiNt+Fh0UjPByd9e7V9SYF YWoVIeT3P704cSuoWh+aZhZW/Zy9bORv8QLNTmHc0MY5lzxga41tw1dl0VpQJtOjNH 7j84woyrctUxuGNSdqkW2TQXVwhFAem6lPV/2dzsi060pIBDgdA+xOHMK0dYCDer4I cFrrVm7I2Ehg17sAbAo17MsDAbO7iq/PIDkfoM5/jmj6i8/OMrjx+2MLBMVUzU8XBU veo5qdlj9Qnuw== Subject: [PATCH 3/3] MAINTAINERS: add Chandan Babu as XFS release manager From: "Darrick J. Wong" To: djwong@kernel.org Cc: Chandan Babu R , Chandan Babu R , linux-xfs@vger.kernel.org, linux-fsdevel@vger.kernel.org, david@fromorbit.com, cem@kernel.org, sandeen@sandeen.net, chandan.babu@oracle.com, amir73il@gmail.com, leah.rumancik@gmail.com, zlang@kernel.org, fstests@vger.kernel.org, willy@infradead.org, shirley.ma@oracle.com, konrad.wilk@oracle.com Date: Fri, 04 Aug 2023 09:25:15 -0700 Message-ID: <169116631533.3243794.12031505140377581673.stgit@frogsfrogsfrogs> In-Reply-To: <169116629797.3243794.7024231508559123519.stgit@frogsfrogsfrogs> References: <169116629797.3243794.7024231508559123519.stgit@frogsfrogsfrogs> User-Agent: StGit/0.19 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org From: Darrick J. Wong I nominate Chandan Babu to take over release management for the upstream kernel's XFS code. He has had sufficient experience merging backports to the 5.4 LTS tree, testing them, and sending them on to the LTS leads. NOTE: I am /not/ nominating Chandan to take on any of the other roles I have just dropped. Bug triager, testing lead, and community manager are open positions that need to be filled. There's also maintainer for supported LTS releases (4.14, 4.19, 5.10...). Cc: Chandan Babu R Signed-off-by: Darrick J. Wong Acked-by: Chandan Babu R Reviewed-by: Carlos Maiolino --- MAINTAINERS | 1 + 1 file changed, 1 insertion(+) diff --git a/MAINTAINERS b/MAINTAINERS index d6b82aac42a4..f059e7c30f90 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -23324,6 +23324,7 @@ F: include/xen/arm/swiotlb-xen.h F: include/xen/swiotlb-xen.h XFS FILESYSTEM +M: Chandan Babu R R: Darrick J. Wong L: linux-xfs@vger.kernel.org S: Supported