From nobody Fri Apr 10 06:22:56 2026 Received: from mail-pl1-f169.google.com (mail-pl1-f169.google.com [209.85.214.169]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4A746233731; Mon, 24 Feb 2025 12:40:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.169 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740400847; cv=none; b=XciWy6fs1e7UuadEL/pvQfwpBdSFZ43iuj29XywiGhjikRO6XSbZkKI0cZyh4ymG3rpzFEpAwjiQWC/2lOgrtRIYQw8s8UGFK6M6GeqczRSmPZO5DahNoUaFxwBajd8JUzoQ4oKtMg3lhq9eSiFjWkk73Pw4ac783PElcKiWkiQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740400847; c=relaxed/simple; bh=ltMkYluF7v4H86I+PLGn409RIPQJDWdAwdWSwrXb2xQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=WPEZmwWrBhfpnK2GuYU7/cah2uw4jo2lcs8ADDK8Mzp5Wd5kYlrZ++INWZK+nRWaXCPbfqVxxi8jDHtDRS6bAanDldf/+ZgJzpaqUNokKb96aGngYqMU0RkHjRAjRfbCyh9++hbYg9i2iReE2NvG2nZYKy4IXE0k2OlnZINh8/w= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=PDhBRG5n; arc=none smtp.client-ip=209.85.214.169 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="PDhBRG5n" Received: by mail-pl1-f169.google.com with SMTP id d9443c01a7336-220c8f38febso88574155ad.2; Mon, 24 Feb 2025 04:40:46 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740400845; x=1741005645; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=CPFBYT/eZDBg2FRRA6Ij22jK0e44FN4G15uWJnLb6Qk=; b=PDhBRG5nLrHs3gnnlJXcV/wRzDF6Q6vAEBYzBZsTRJIIDZnJyXeu3Kpg5ncu49HBF6 7aAwlVQeyPZs7hybiIR6n7iTSaaMTgR+iBUuROl0XOhOCvJS+HjnFRqClX0KbNW1m+2X OERTrIaWOMGpOrthQYhrkBINyTWKnrrfjTNC/wlqnAhPBdXkmYyUfbqJxIgHhAHGxcZQ O9c+HojFtk7Q5p7ewudSGHkYaYP6OhBQpZYCj2FMavvajMBtbQorXXXe7F+iwu9SG2ma gWa+9HTUenJZwi9wPoY33UqbY7PGdE6FDf6rO/5EvNeq1eQz4hyGZVpFLuXfE/kBcQKh 6XLg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740400845; x=1741005645; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=CPFBYT/eZDBg2FRRA6Ij22jK0e44FN4G15uWJnLb6Qk=; b=Tk975H/5Zd5qwGBnrl4x03APzVBHmmsl41DTNU1HOfxW+Xp4THEETTU4pwZobymrm7 jRpFbp6ivdEJ+DOpbQ/+RhQR9pq9rB6GlFKP0tRh/ZCiyaYduaqEtR+a0d/fYVvU3bE9 E4VK2n4gtbAO6tavI1db79547BlFnoprB60q9BY+FLwdNTtXiyAUB9bbVrmHyuibHd9E DKIH/Ljh4pC1DjtJN972Ycw8UyK8dtGMuZ1LLCRH57mtDDXRN2IO9q3T6rjQcnCQAfyC piN7hoySE5XzQaBcxbWsfrGo2utjk5yT28FjICw/Lt2Kp6m2B+ritQtb1m9pKltkppdL MHeg== X-Forwarded-Encrypted: i=1; AJvYcCVBkkyGyw5Y9lVW97DyqjLyTSOMvukexb2C24EMDz7Mw6dEhjowABCcm8EQmlIBaB4k14lsgRBzCK7T13YB6g==@vger.kernel.org, AJvYcCX9dhPGnEf6mXxTOPb8F5kadhOnaNLLUZBhpJ5c7qs7mEzj2XZvzDqv2zRoFldzk1s+YvFTB+bQn1Y/@vger.kernel.org X-Gm-Message-State: AOJu0YzYtJ18mUKSiouYeMH+TSQUEJrpUm2d39ZUdjuyiFqBv4IK6YBc 4LYCFwhqBUYsewtnVkXvUI0JP8hBWwxYFp5WlICbriHvRq4wllAY X-Gm-Gg: ASbGncszPj2yTHpyTsfRilk2oUjM1OwjPVAeFpOsjOL/A6F5fPMbqXoFNQ4ntQbYPSS s4dTO/OhpR2zh5qW/buWi/nA5i94Q9ErA03mWr3F3da1jPZNcqMQL61yzYHUzQFk7x1VyhhsKSM O0h28TB5iYT7xuTIIoyyx+Q7qqHPHprlGcofpvPeo5mlI9d1DsoL4EIMS/itgxf+rN1/Gq2zJ59 QwKZiWIHv5tQdSeL/5rFGw0UHorrR1ciApT+IcRVSuTLNCyqM8DxzFCQrE/G2J72+lXE5Q0X3jl yN6lpr5to32R55VJYKl9HA39Dw== X-Google-Smtp-Source: AGHT+IGlrqpxrCJHs+wl2oqV3t76Dp4tdLNd/o4ccrDlub4xpdcRibwIr/Hwl/Oc0OmQyBQaCr+mXA== X-Received: by 2002:a17:902:ec8c:b0:21f:3e2d:7d2e with SMTP id d9443c01a7336-2219ffb8b65mr194086615ad.27.1740400845365; Mon, 24 Feb 2025 04:40:45 -0800 (PST) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-220d545d088sm177926175ad.129.2025.02.24.04.40.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Feb 2025 04:40:43 -0800 (PST) Received: by archie.me (Postfix, from userid 1000) id 8D2E9412B0AC; Mon, 24 Feb 2025 19:40:39 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux bcachefs Cc: Kent Overstreet , Jonathan Corbet , Wei Liu , Easwar Hariharan , Michael Kelley , Purva Yeshi , Bagas Sanjaya Subject: [PATCH 1/3] Documentation: bcachefs: Split index toctree Date: Mon, 24 Feb 2025 19:40:26 +0700 Message-ID: <20250224124028.42059-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250224124028.42059-1-bagasdotme@gmail.com> References: <20250224124028.42059-1-bagasdotme@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1522; i=bagasdotme@gmail.com; h=from:subject; bh=ltMkYluF7v4H86I+PLGn409RIPQJDWdAwdWSwrXb2xQ=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDOl7Mvi68g8YGu6fzStvKeb69JvaxLOLC2/F/vcr2fO3a PekgjTdjlIWBjEuBlkxRZZJiXxNp3cZiVxoX+sIM4eVCWQIAxenAEzk9QGG/x5vLIVn+0xfuVHw X03z4U1uwd4r7m0LPBmbPDPA4cK3bn6G/w7xE54vejn1hs1U7QZ/jT3XnJVy7i32jhaZ/2rH5yW LVnECAA== X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" bcachefs subsystem currently has 4 docs: two are development notes and the rest are actual filesystem docs. These two groups are clearly distinct and can be organized. Split the toctree into two, one for each docs group. While at it, also reduce :maxdepth: so that only title headings are listed in the toctrees. Signed-off-by: Bagas Sanjaya --- Documentation/filesystems/bcachefs/index.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/Documentation/filesystems/bcachefs/index.rst b/Documentation/f= ilesystems/bcachefs/index.rst index 0415b5d781920d..3864d0ae89c10b 100644 --- a/Documentation/filesystems/bcachefs/index.rst +++ b/Documentation/filesystems/bcachefs/index.rst @@ -4,11 +4,28 @@ bcachefs Documentation =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 +Subsystem-specific development process notes +-------------------------------------------- + +Development notes specific to bcachefs. These are intended to supplement +:doc:`general kernel development handbook `. + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :numbered: =20 CodingStyle SubmittingPatches + +Filesystem implementation +------------------------- + +Documentation for filesystem features and their implementation details. +At this moment, only a few of these are described here. + +.. toctree:: + :maxdepth: 1 + :numbered: + casefolding errorcodes --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 10 06:22:56 2026 Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 9E22923370D; Mon, 24 Feb 2025 12:40:44 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.173 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740400846; cv=none; b=UzN5ytQl5nOFkGK6BVV27R7AJQ/AX3CKUBBgiChoLqW+z3noV5rlkEyNcSdTQ1dEW3F8RXWb/8RNc2vkKWdXQEyMnDBddPJ73pXe5Ha5XirzVfg19SAOv4EuYJeHSkvlVOw5lF49PyQiO8sYM9MNe2UlHySgN+HKgf/nNYgva8Q= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740400846; c=relaxed/simple; bh=rUYeLMwkMWE93iox1zqi2IL9CD9/fZmi24Dwjgci5lM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=kTZf16s/QVh8xz7hIW3Tisw3bztBnLpN9wvxpNfvJko4NSmp21Elc/o/NeGlKzWlfnb98vH7Rk314bouT/6l26PCuH2ICz6Dq/dzLXdYx6O7nT0ZCuKLuG5LV7qHgZtfV9bqerWdqdcFsI6GqByc2YUXuXo6f7IISuhWy1/r/Qc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=GyNMrFA5; arc=none smtp.client-ip=209.85.214.173 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="GyNMrFA5" Received: by mail-pl1-f173.google.com with SMTP id d9443c01a7336-220dc3831e3so81461955ad.0; Mon, 24 Feb 2025 04:40:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740400844; x=1741005644; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=nH1mRhJzXJ+lnurKcLbDcsTkl48NjRzRyTmoQVE9c+o=; b=GyNMrFA5ZeVdZo9EvVUlXxLQHkhqu7CdJ9jd+DFYNt4/1xeg6AkdRUJee2/6W/oWTe ZJ+3S38FTh+9b2N55yrQIm1quUYDVGEJWZfcBGIIDoB7VKAuxmzLPWmqJ9BLl3rw0HbT vo6T7RjUPgA4MoS7uqCPQlgno6SFVNQA3DfQ3vgsRZSdo7qcJUpNy2DGzLtqGRopVWfY hFaWerZpYSwjHizlzKY5xGIpeMG3I7XpNlnibYylyxAtBrbov/2kINQ5fT2VmBT42I1+ m3oWMd3U7UU8/0TdaBXnqK4BhUw6qnnvbe3valvxg8pjfQ2w6gKk1Z13Z281p38LeX/Y F/nQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740400844; x=1741005644; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=nH1mRhJzXJ+lnurKcLbDcsTkl48NjRzRyTmoQVE9c+o=; b=SJ1ubtsCINtJqc1GQU0Ik2X3Lq2gNYBeAv0AbG6AU5uWsrDy5w9f9KzJ+48hubJkZY P8f1C7v39Gv5HBSSa+3l/TlfxFDKcvBspgPlgiFgb/kA4nmiSBGQzshSkRmli6hghPM1 V2+V/5QK34TciyjS+DdhuHw6mAH7/KycJ0Sx7sgJ/ImReiabDOdxr7SfiD1u4vg3X63c cEYKlyRs9s4nuu6k9h2uUWOvXLkDDDkARaib28pcIjoTEtW19aeaiCiI2c7BtUGYYiuz IBgu9KX8Ctff53A1CoBs+I0MBeMq8ACKLWjGaFwB0bMqr4StY54YaNGSyiSx1YWFXp7P 5J2w== X-Forwarded-Encrypted: i=1; AJvYcCVpKtt/SJ9BW4VSxzpO+XPcgfebTm8E6neIN9D8QIAUJz8wN5xm8IWTp94LYGrDTnySO+C2PcPBF8XJbqmWlA==@vger.kernel.org, AJvYcCX4dLHtYnokxILv0r79dNFze7gc/OFenG6UbWaVPInQN0UkUwTxZlOcjr+BawLOzPj45L2BkRfKGc9q@vger.kernel.org X-Gm-Message-State: AOJu0YwNMDw/PYxlyeuxVZBvi2O6Ja51Etst4AcM19noIOyBHAeoq7N4 V22WFml28jk5wd7lEHFVCOcasc2ToAGouxEFQgZe74MwPLtMD2sm X-Gm-Gg: ASbGncsI/7T0Zi7yku8bihCAI0KuL0Ak+eQXwenTNBFm9ZJVafpbqJybm+EiyXFCq7G XaB2dGGIbA0NtrqJflGghE3GQDfko/xyXC5R1EJwrh42TfhLFF96YAkn+cqbiVR5gMHFjhlH3sh LCOlnk3mau7641qWLcXQP9MME8Fz5uZ1SqdI0bn7EuT8WLfbzToUsWMqqQw2MK1Z5ugQSrplcMi g6jVNlq7DeNvbCpsHmpfIdJrU55DTnHEjQ8UBikozyxKdy4kb1ZfJ9bTg7sdT2wyNTQjB4h11ox PJHYROcO56Gfiq778xVIKriy/Q== X-Google-Smtp-Source: AGHT+IEu2NKaB1pzYSUxuWN+h1ruzdodzFrBeuRDBRh+Q54BlMwWVgApQaE9iz0ag3B/SR8Ok6MWbQ== X-Received: by 2002:a05:6a00:cc8:b0:730:949d:2d52 with SMTP id d2e1a72fcca58-73425b39e5cmr21655893b3a.3.1740400843526; Mon, 24 Feb 2025 04:40:43 -0800 (PST) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7326973705fsm16511425b3a.7.2025.02.24.04.40.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Feb 2025 04:40:43 -0800 (PST) Received: by archie.me (Postfix, from userid 1000) id A150141296DA; Mon, 24 Feb 2025 19:40:39 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux bcachefs Cc: Kent Overstreet , Jonathan Corbet , Wei Liu , Easwar Hariharan , Michael Kelley , Purva Yeshi , Bagas Sanjaya Subject: [PATCH 2/3] Documentation: bcachefs: SubmittingPatches: Demote section headings Date: Mon, 24 Feb 2025 19:40:27 +0700 Message-ID: <20250224124028.42059-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250224124028.42059-1-bagasdotme@gmail.com> References: <20250224124028.42059-1-bagasdotme@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2721; i=bagasdotme@gmail.com; h=from:subject; bh=rUYeLMwkMWE93iox1zqi2IL9CD9/fZmi24Dwjgci5lM=; b=kA0DAAoW9rmJSVVRTqMByyZiAGe8aA6jTkfvzf4RMVKT5o9/T46l4ytB4uFflXl4x1Uz38ngM oh1BAAWCgAdFiEEkmEOgsu6MhTQh61B9rmJSVVRTqMFAme8aA4ACgkQ9rmJSVVRTqMKTAD9G27v PuR3/QS5lCB1vr8+uZegGaiYpgWUa3vRaK7NfhIA/i+Ur2pnhXgPHhdagqbM49W2jlejZf1VU7/ Vwbl9Vf4A X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" SubmttingPatches.rst has 4 section headings, all under the same heading levels. In absence of title headings, these section headings are all ended up as title headings in the docs output, which also affect the index toctree (increasing titles to 6 from the original 2) due to :numbered: option. Demote second-to-last section headings, making "Submitting patches to bcachefs" as title heading. Signed-off-by: Bagas Sanjaya --- .../bcachefs/SubmittingPatches.rst | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/Documentation/filesystems/bcachefs/SubmittingPatches.rst b/Doc= umentation/filesystems/bcachefs/SubmittingPatches.rst index 026b12ae0d6a20..ece0e85d259807 100644 --- a/Documentation/filesystems/bcachefs/SubmittingPatches.rst +++ b/Documentation/filesystems/bcachefs/SubmittingPatches.rst @@ -1,5 +1,10 @@ -Submitting patches to bcachefs: -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D +Submitting patches to bcachefs +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D + +Here are suggestions for submitting patches to bcachefs subsystem. + +Submission checklist +-------------------- =20 Patches must be tested before being submitted, either with the xfstests su= ite [0], or the full bcachefs test suite in ktest [1], depending on what's bei= ng @@ -26,8 +31,8 @@ considered out of date), but try not to deviate too much = without reason. Focus on writing code that reads well and is organized well; code should be aesthetically pleasing. =20 -CI: -=3D=3D=3D +CI +-- =20 Instead of running your tests locally, when running the full test suite it= 's prefereable to let a server farm do it in parallel, and then have the resu= lts @@ -39,8 +44,8 @@ a big tech company, you'll need to help out with server c= osts to get access - but the CI is not restricted to running bcachefs tests: it runs any ktest = test (which generally makes it easy to wrap other tests that can run in qemu). =20 -Other things to think about: -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D +Other things to think about +--------------------------- =20 - How will we debug this code? Is there sufficient introspection to diagno= se when something starts acting wonky on a user machine? @@ -79,8 +84,8 @@ Other things to think about: tested? (Automated tests exists but aren't in the CI, due to the hassle = of disk image management; coordinate to have them run.) =20 -Mailing list, IRC: -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Mailing list, IRC +----------------- =20 Patches should hit the list [3], but much discussion and code review happe= ns on IRC as well [4]; many people appreciate the more conversational approach a= nd --=20 An old man doll... just what I always wanted! - Clara From nobody Fri Apr 10 06:22:56 2026 Received: from mail-pl1-f171.google.com (mail-pl1-f171.google.com [209.85.214.171]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D6449158870; Mon, 24 Feb 2025 12:40:43 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.171 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740400845; cv=none; b=GMh5WS8OxfWCrde2bKgg4VIwC2kc0iRps0nrjeJkoIirXcMi1IllRqk8D2r0sU1Y7LDI4jD4Xv69UEOAhUYFPRtdsaBlU2wGXqktRU1mZ+W6Dwb6MWi6m+KgRMi9z5IhZMhWB9qHA4GuhzH6uBL2FLOoL2iFhjzGesF0Y4MOI/s= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740400845; c=relaxed/simple; bh=SQLajT4z7bmfJBkPXz2F5dIaF9jtUs4cUyT6QRWnEg4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=kf5jN5ALNxqCCSB54dCSoF+dN/y1khq2tcgpOoSjlONLZHQ2mymZtwuIkARiLr4oHZuLdDNUYgsqkSDXGnBp1rTsaRp5rIlunzwd46YWDRTPi/+jR+xEo/e4c1CzpmnryjslMooH20lIrr3uYd8RhmCnN6KXD/ZR7RwvoaPlm+o= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=X32UPvtm; arc=none smtp.client-ip=209.85.214.171 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="X32UPvtm" Received: by mail-pl1-f171.google.com with SMTP id d9443c01a7336-22114b800f7so81896355ad.2; Mon, 24 Feb 2025 04:40:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740400843; x=1741005643; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=vxDhcIIfOi0Ejcuhqf9fXn1q3Kj1XENHhTye07+0O3o=; b=X32UPvtmPt/kTECk8AdMYyZ0RraFIEl+jW0XV26xkcvVFHR3WGAFpyj+u4bMZFMMrq 9Q3rWCLE8mcJ/mfDFZNjmNTA5wsJasPhdLfjAZwKkIz7MTo/fN2zP9KwOGjIfeVs86za qtIvElfjdDj863PGrzE2nLxw+ptY4XQc6/LcLcXlvO3ToxBWogyzxjzQCR12bYaK14Bj Sqd1Gi8VLKHI1IOOLlzNbV9F/SSViaVnej/ZHsUXLG3yCkUaWU+kRh5LL8g79jFFuLxh yfkT/fAp0cYKCgozZsn00KWyvPM4HjkVrN8kC/UsyLAHlWQNaKwWXpxZuHwofHOG511H iUkw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740400843; x=1741005643; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=vxDhcIIfOi0Ejcuhqf9fXn1q3Kj1XENHhTye07+0O3o=; b=tkmCT4MqwPhQ2OhIDKZTvTb7mJlA51A3D1ldsOyOzOO1rJ5GsgZYpYdj0221c4G4vL um7V8g8mvN8oqB8BKJiVSMqtG9S82ApKDVoyieHrAUZjNaEDJbzJHg7ePe2yCjxLFuQR Q3WREZjYD7c9ioGASaFybl67FwfkI/zX+aeKl0veXApuY0fU/GJzL6lVj53AXJDDkROA 9uUrfPoy/V9VbRK1aL6cO+4GOxkzqa1cuzjCn+xl0sEvQ8M8JTAjSdI4kfRQvE0mrxhr vmJs8BCORuUD7oy2re7JAbVFbUE4Y7Y5y3p4CaDJOJ40NQXu3+DidyMNW8tNkoZXBR9N iktQ== X-Forwarded-Encrypted: i=1; AJvYcCVfDhBN0EB0YgGV4o7fUFdaGTHFbBu8mcXJ0GKDFKatFI9Jcljpmr0jT4kdcbctnc8fJAaj9vsT/F+JqThtpA==@vger.kernel.org, AJvYcCWbBhhXtj9KXsNaGGc1FJAF/G5wjxGwSD3PS5loZNS6Y0GHLo8tLeLLMDvQwJMq/951RyOGkZyiYTru@vger.kernel.org X-Gm-Message-State: AOJu0YyukfKy8vflTXo+IygXA0Sp9rHAclQVMOSfGqMdWmm7baC8S+Gf 009yooIBEWk7XhnI/HFezQ9mKpwcCf1gBZ1YV1a3q5JyI1Fe40ER X-Gm-Gg: ASbGncthWKLnUKUmilc2+WG3I9qvOk7dg2EU36oaeAuNeXyaEGceHjMStEC2/bBEwtO 3Awc6BA2KvNgn42WqjIY+dAKvdWMXyXl3e7TL/Z408Oim5kP/otWZIeG9tX0fOAxBOCZM2ax9hj MY0+p3rgeDecRGM4Spr67nWBGlpDlT970ee/DWpwcmEEkAbSkDm3b1sTbdOBouhsbN6ypwAs8tY GaONOPJB+Ck1Em2RhLNoaPJesXfTyIDvjU5e0ajaTCemVWANh7dVYFKGmAfqjnDKFKluNfvJI49 0VF83PY5vn083mo191psQbP2cg== X-Google-Smtp-Source: AGHT+IHukjlTpSyyANyf1X0RijEHy54FY3sjovR1jYsCe6rqYOD7JUQhxb6PZDsCkAItbtOAJRfGSQ== X-Received: by 2002:a17:903:944:b0:220:f449:7415 with SMTP id d9443c01a7336-2219fff18c3mr254529245ad.44.1740400842823; Mon, 24 Feb 2025 04:40:42 -0800 (PST) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2210005641dsm149187185ad.210.2025.02.24.04.40.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Feb 2025 04:40:42 -0800 (PST) Received: by archie.me (Postfix, from userid 1000) id A97A541296DB; Mon, 24 Feb 2025 19:40:39 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux bcachefs Cc: Kent Overstreet , Jonathan Corbet , Wei Liu , Easwar Hariharan , Michael Kelley , Purva Yeshi , Bagas Sanjaya Subject: [PATCH 3/3] Documentation: bcachefs: SubmittingPatches: Convert footnotes to reST syntax Date: Mon, 24 Feb 2025 19:40:28 +0700 Message-ID: <20250224124028.42059-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250224124028.42059-1-bagasdotme@gmail.com> References: <20250224124028.42059-1-bagasdotme@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=3071; i=bagasdotme@gmail.com; h=from:subject; bh=SQLajT4z7bmfJBkPXz2F5dIaF9jtUs4cUyT6QRWnEg4=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDOl7MvhKFup8/Tn5rp5DaJ6h0toEo6nPTsqwHNLZmVkYv pLL1tC0o5SFQYyLQVZMkWVSIl/T6V1GIhfa1zrCzGFlAhnCwMUpABPZEMbIcHCXodvP1MkhMcUp Fj0L6uuz/02qYZ2w5PzHe/PUo7LsVBgZ9kz6wV2VaHB4/Yeo8pQzU9YmGnvO7Xn5Y+59pvkG80O 3sQIA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Footnotes list are outputted in htmldocs simply as long-running paragraph instead. Use reST numbered footnotes syntax for the job. Signed-off-by: Bagas Sanjaya --- .../bcachefs/SubmittingPatches.rst | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/Documentation/filesystems/bcachefs/SubmittingPatches.rst b/Doc= umentation/filesystems/bcachefs/SubmittingPatches.rst index ece0e85d259807..a455f9cfd15c79 100644 --- a/Documentation/filesystems/bcachefs/SubmittingPatches.rst +++ b/Documentation/filesystems/bcachefs/SubmittingPatches.rst @@ -7,7 +7,7 @@ Submission checklist -------------------- =20 Patches must be tested before being submitted, either with the xfstests su= ite -[0], or the full bcachefs test suite in ktest [1], depending on what's bei= ng +[0]_, or the full bcachefs test suite in ktest [1]_, depending on what's b= eing touched. Note that ktest wraps xfstests and will be an easier method to ru= nning it for most users; it includes single-command wrappers for all the mainstr= eam in-kernel local filesystems. @@ -39,7 +39,7 @@ prefereable to let a server farm do it in parallel, and t= hen have the results in a nice test dashboard (which can tell you which failures are new, and presents results in a git log view, avoiding the need for most bisecting). =20 -That exists [2], and community members may request an account. If you work= for +That exists [2]_, and community members may request an account. If you wor= k for a big tech company, you'll need to help out with server costs to get acces= s - but the CI is not restricted to running bcachefs tests: it runs any ktest = test (which generally makes it easy to wrap other tests that can run in qemu). @@ -87,17 +87,19 @@ Other things to think about Mailing list, IRC ----------------- =20 -Patches should hit the list [3], but much discussion and code review happe= ns on -IRC as well [4]; many people appreciate the more conversational approach a= nd -quicker feedback. +Patches should hit the list [3]_, but much discussion and code review happ= ens +on IRC as well [4]_; many people appreciate the more conversational approa= ch +and quicker feedback. =20 Additionally, we have a lively user community doing excellent QA work, whi= ch exists primarily on IRC. Please make use of that resource; user feedback is important for any nontrivial feature, and documenting it in commit messages would be a good idea. =20 -[0]: git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git -[1]: https://evilpiepirate.org/git/ktest.git/ -[2]: https://evilpiepirate.org/~testdashboard/ci/ -[3]: linux-bcachefs@vger.kernel.org -[4]: irc.oftc.net#bcache, #bcachefs-dev +.. rubric:: References + +.. [0] git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git +.. [1] https://evilpiepirate.org/git/ktest.git/ +.. [2] https://evilpiepirate.org/~testdashboard/ci/ +.. [3] linux-bcachefs@vger.kernel.org +.. [4] irc.oftc.net#bcache, #bcachefs-dev --=20 An old man doll... just what I always wanted! - Clara