From nobody Wed Dec 17 11:32:13 2025 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 3424BC25B47 for ; Fri, 27 Oct 2023 08:20:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235287AbjJ0IUa (ORCPT ); Fri, 27 Oct 2023 04:20:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34016 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235296AbjJ0IUB (ORCPT ); Fri, 27 Oct 2023 04:20:01 -0400 Received: from mx0a-00069f02.pphosted.com (mx0a-00069f02.pphosted.com [205.220.165.32]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 99EF81996; Fri, 27 Oct 2023 01:19:35 -0700 (PDT) Received: from pps.filterd (m0246627.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 39R5iCdg020786; Fri, 27 Oct 2023 08:19:25 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-type : content-transfer-encoding; s=corp-2023-03-30; bh=3Wu6bIg7tVvARFbVYaBYPJjOg+gs9lUaxjqSIpedt0E=; b=gLX/GWaCBpyh1Lw+Mg5zW/ROBo2V7+vbr0cGfLNNAEBpV3J8c4crQgFYu7kTsk2VOgCB 419izoc3g9sD9pGD8O0mjqfBxUsKO12FRYO907Kj4GoK7L/C4/us05ktxrikmTGg4IoU WWg6xhlFTK1alsAlFY120lkgFn0dd+rcAit19QNs0ig6WAKGO1Veq2ajKTcj0DWInDXJ AQ7v89Db1RoRCQzmmEcJItUDE256ZQAmMjL40ygtN2puuEosYzRoO2deDreKY1vV5NlR bu31FNiY5m9+DcJx8DQP/oVbdsm7JKuH4ffqkyRQ7gMDvz8I+pGJ69uMjWaRQnuyOdAO 7g== Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.appoci.oracle.com [138.1.37.129]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3tyx4tgx0y-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:19:25 +0000 Received: from pps.filterd (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (8.17.1.19/8.17.1.19) with ESMTP id 39R6HWAx009159; Fri, 27 Oct 2023 08:19:12 GMT Received: from pps.reinject (localhost [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTPS id 3tywqjebh6-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:19:12 +0000 Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by pps.reinject (8.17.1.5/8.17.1.5) with ESMTP id 39R8Ig9d028975; Fri, 27 Oct 2023 08:19:11 GMT Received: from t460-2.nl.oracle.com (dhcp-10-175-63-126.vpn.oracle.com [10.175.63.126]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTP id 3tywqjeb1g-11; Fri, 27 Oct 2023 08:19:11 +0000 From: Vegard Nossum To: linux-doc@vger.kernel.org, Jonathan Corbet , Mauro Carvalho Chehab Cc: Jani Nikula , linux-kernel@vger.kernel.org, Vegard Nossum , Federico Vaga , Alex Shi , Yanteng Si , Hu Haowen , workflows@vger.kernel.org Subject: [PATCH RFC 10/11] docs: use toctree :caption: and move introduction Date: Fri, 27 Oct 2023 10:18:29 +0200 Message-Id: <20231027081830.195056-11-vegard.nossum@oracle.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231027081830.195056-1-vegard.nossum@oracle.com> References: <20231027081830.195056-1-vegard.nossum@oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.987,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2023-10-27_06,2023-10-26_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 phishscore=0 mlxlogscore=999 mlxscore=0 spamscore=0 suspectscore=0 adultscore=0 bulkscore=0 malwarescore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2310240000 definitions=main-2310270071 X-Proofpoint-GUID: aNYiUgR9x7UUOkNNILohSUk0CHjwFX3r X-Proofpoint-ORIG-GUID: aNYiUgR9x7UUOkNNILohSUk0CHjwFX3r Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The canonical way to add a heading to the ToC is to use :caption:. Do that. Let's also move the introduction to the top of the document to be consistent with most other documents. Cc: Jonathan Corbet Cc: Mauro Carvalho Chehab Cc: Federico Vaga Cc: Alex Shi Cc: Yanteng Si Cc: Hu Haowen Cc: workflows@vger.kernel.org Signed-off-by: Vegard Nossum --- Documentation/process/development-process.rst | 19 +++++++++---------- .../it_IT/process/development-process.rst | 19 +++++++++---------- .../zh_CN/process/development-process.rst | 5 ++--- .../zh_TW/process/development-process.rst | 5 ++--- 4 files changed, 22 insertions(+), 26 deletions(-) diff --git a/Documentation/process/development-process.rst b/Documentation/= process/development-process.rst index 61c627e41ba8..e34d7da58b7f 100644 --- a/Documentation/process/development-process.rst +++ b/Documentation/process/development-process.rst @@ -3,9 +3,17 @@ A guide to the Kernel Development Process =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=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -Contents: +The purpose of this document is to help developers (and their managers) +work with the development community with a minimum of frustration. It is +an attempt to document how this community works in a way which is +accessible to those who are not intimately familiar with Linux kernel +development (or, indeed, free software development in general). While +there is some technical material here, this is very much a process-oriented +discussion which does not require a deep knowledge of kernel programming to +understand. =20 .. toctree:: + :caption: Contents :numbered: :maxdepth: 2 =20 @@ -17,12 +25,3 @@ Contents: 6.Followthrough 7.AdvancedTopics 8.Conclusion - -The purpose of this document is to help developers (and their managers) -work with the development community with a minimum of frustration. It is -an attempt to document how this community works in a way which is -accessible to those who are not intimately familiar with Linux kernel -development (or, indeed, free software development in general). While -there is some technical material here, this is very much a process-oriented -discussion which does not require a deep knowledge of kernel programming to -understand. diff --git a/Documentation/translations/it_IT/process/development-process.r= st b/Documentation/translations/it_IT/process/development-process.rst index f1a6eca30824..20e77c9816a1 100644 --- a/Documentation/translations/it_IT/process/development-process.rst +++ b/Documentation/translations/it_IT/process/development-process.rst @@ -8,9 +8,17 @@ Una guida al processo di sviluppo del Kernel =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=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -Contenuti: +Lo scopo di questo documento =C3=A8 quello di aiutare gli sviluppatori (ed= i loro +supervisori) a lavorare con la communit=C3=A0 di sviluppo con il minimo sf= orzo. =C3=88 +un tentativo di documentare il funzionamento di questa communit=C3=A0 in m= odo che +sia accessibile anche a coloro che non hanno famigliarit=C3=A0 con lo svil= uppo del +Kernel Linux (o, anzi, con lo sviluppo di software libero in generale). B= ench=C3=A8 +qui sia presente del materiale tecnico, questa =C3=A8 una discussione rivo= lta in +particolare al procedimento, e quindi per essere compreso non richiede una +conoscenza approfondit=C3=A0 sullo sviluppo del kernel. =20 .. toctree:: + :caption: Contenuti :numbered: :maxdepth: 2 =20 @@ -22,12 +30,3 @@ Contenuti: 6.Followthrough 7.AdvancedTopics 8.Conclusion - -Lo scopo di questo documento =C3=A8 quello di aiutare gli sviluppatori (ed= i loro -supervisori) a lavorare con la communit=C3=A0 di sviluppo con il minimo sf= orzo. =C3=88 -un tentativo di documentare il funzionamento di questa communit=C3=A0 in m= odo che -sia accessibile anche a coloro che non hanno famigliarit=C3=A0 con lo svil= uppo del -Kernel Linux (o, anzi, con lo sviluppo di software libero in generale). B= ench=C3=A8 -qui sia presente del materiale tecnico, questa =C3=A8 una discussione rivo= lta in -particolare al procedimento, e quindi per essere compreso non richiede una -conoscenza approfondit=C3=A0 sullo sviluppo del kernel. diff --git a/Documentation/translations/zh_CN/process/development-process.r= st b/Documentation/translations/zh_CN/process/development-process.rst index 30cffe66c075..c10d8e2e21eb 100644 --- a/Documentation/translations/zh_CN/process/development-process.rst +++ b/Documentation/translations/zh_CN/process/development-process.rst @@ -8,9 +8,10 @@ =E5=86=85=E6=A0=B8=E5=BC=80=E5=8F=91=E8=BF=87=E7=A8=8B=E6=8C=87=E5=8D=97 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -=E5=86=85=E5=AE=B9: +=E6=9C=AC=E6=96=87=E6=A1=A3=E7=9A=84=E7=9B=AE=E7=9A=84=E6=98=AF=E5=B8=AE= =E5=8A=A9=E5=BC=80=E5=8F=91=E4=BA=BA=E5=91=98=EF=BC=88=E5=8F=8A=E5=85=B6=E7= =BB=8F=E7=90=86=EF=BC=89=E4=BB=A5=E6=9C=80=E5=B0=8F=E7=9A=84=E6=8C=AB=E6=8A= =98=E6=84=9F=E4=B8=8E=E5=BC=80=E5=8F=91=E7=A4=BE=E5=8C=BA=E5=90=88=E4=BD=9C= =E3=80=82=E5=AE=83=E8=AF=95=E5=9B=BE=E8=AE=B0=E5=BD=95=E8=BF=99=E4=B8=AA=E7= =A4=BE=E5=8C=BA=E5=A6=82=E4=BD=95=E4=BB=A5=E4=B8=80=E7=A7=8D=E4=B8=8D=E7=86= =9F=E6=82=89Linux=E5=86=85=E6=A0=B8=E5=BC=80=E5=8F=91=EF=BC=88=E6=88=96=E8= =80=85=E5=AE=9E=E9=99=85=E4=B8=8A=E6=98=AF=E8=87=AA=E7=94=B1=E8=BD=AF=E4=BB= =B6=E5=BC=80=E5=8F=91=EF=BC=89=E7=9A=84=E4=BA=BA=E5=8F=AF=E4=BB=A5=E8=AE=BF= =E9=97=AE=E7=9A=84=E6=96=B9=E5=BC=8F=E5=B7=A5=E4=BD=9C=E3=80=82=E8=99=BD=E7= =84=B6=E8=BF=99=E9=87=8C=E6=9C=89=E4=B8=80=E4=BA=9B=E6=8A=80=E6=9C=AF=E8=B5= =84=E6=96=99=EF=BC=8C=E4=BD=86=E8=BF=99=E6=98=AF=E4=B8=80=E4=B8=AA=E9=9D=A2= =E5=90=91=E8=BF=87=E7=A8=8B=E7=9A=84=E8=AE=A8=E8=AE=BA=EF=BC=8C=E4=B8=8D=E9= =9C=80=E8=A6=81=E6=B7=B1=E5=85=A5=E4=BA=86=E8=A7=A3=E5=86=85=E6=A0=B8=E7=BC= =96=E7=A8=8B=E5=B0=B1=E5=8F=AF=E4=BB=A5=E7=90=86=E8=A7=A3=E3=80=82 =20 .. toctree:: + :caption: =E5=86=85=E5=AE=B9 :numbered: :maxdepth: 2 =20 @@ -22,5 +23,3 @@ 6.Followthrough 7.AdvancedTopics 8.Conclusion - -=E6=9C=AC=E6=96=87=E6=A1=A3=E7=9A=84=E7=9B=AE=E7=9A=84=E6=98=AF=E5=B8=AE= =E5=8A=A9=E5=BC=80=E5=8F=91=E4=BA=BA=E5=91=98=EF=BC=88=E5=8F=8A=E5=85=B6=E7= =BB=8F=E7=90=86=EF=BC=89=E4=BB=A5=E6=9C=80=E5=B0=8F=E7=9A=84=E6=8C=AB=E6=8A= =98=E6=84=9F=E4=B8=8E=E5=BC=80=E5=8F=91=E7=A4=BE=E5=8C=BA=E5=90=88=E4=BD=9C= =E3=80=82=E5=AE=83=E8=AF=95=E5=9B=BE=E8=AE=B0=E5=BD=95=E8=BF=99=E4=B8=AA=E7= =A4=BE=E5=8C=BA=E5=A6=82=E4=BD=95=E4=BB=A5=E4=B8=80=E7=A7=8D=E4=B8=8D=E7=86= =9F=E6=82=89Linux=E5=86=85=E6=A0=B8=E5=BC=80=E5=8F=91=EF=BC=88=E6=88=96=E8= =80=85=E5=AE=9E=E9=99=85=E4=B8=8A=E6=98=AF=E8=87=AA=E7=94=B1=E8=BD=AF=E4=BB= =B6=E5=BC=80=E5=8F=91=EF=BC=89=E7=9A=84=E4=BA=BA=E5=8F=AF=E4=BB=A5=E8=AE=BF= =E9=97=AE=E7=9A=84=E6=96=B9=E5=BC=8F=E5=B7=A5=E4=BD=9C=E3=80=82=E8=99=BD=E7= =84=B6=E8=BF=99=E9=87=8C=E6=9C=89=E4=B8=80=E4=BA=9B=E6=8A=80=E6=9C=AF=E8=B5= =84=E6=96=99=EF=BC=8C=E4=BD=86=E8=BF=99=E6=98=AF=E4=B8=80=E4=B8=AA=E9=9D=A2= =E5=90=91=E8=BF=87=E7=A8=8B=E7=9A=84=E8=AE=A8=E8=AE=BA=EF=BC=8C=E4=B8=8D=E9= =9C=80=E8=A6=81=E6=B7=B1=E5=85=A5=E4=BA=86=E8=A7=A3=E5=86=85=E6=A0=B8=E7=BC= =96=E7=A8=8B=E5=B0=B1=E5=8F=AF=E4=BB=A5=E7=90=86=E8=A7=A3=E3=80=82 diff --git a/Documentation/translations/zh_TW/process/development-process.r= st b/Documentation/translations/zh_TW/process/development-process.rst index f4cf5c2bbc82..c4db0e3e72ce 100644 --- a/Documentation/translations/zh_TW/process/development-process.rst +++ b/Documentation/translations/zh_TW/process/development-process.rst @@ -11,9 +11,10 @@ =E5=85=A7=E6=A0=B8=E9=96=8B=E7=99=BC=E9=81=8E=E7=A8=8B=E6=8C=87=E5=8D=97 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -=E5=85=A7=E5=AE=B9: +=E6=9C=AC=E6=96=87=E6=AA=94=E7=9A=84=E7=9B=AE=E7=9A=84=E6=98=AF=E5=B9=AB= =E5=8A=A9=E9=96=8B=E7=99=BC=E4=BA=BA=E5=93=A1=EF=BC=88=E5=8F=8A=E5=85=B6=E7= =B6=93=E7=90=86=EF=BC=89=E4=BB=A5=E6=9C=80=E5=B0=8F=E7=9A=84=E6=8C=AB=E6=8A= =98=E6=84=9F=E8=88=87=E9=96=8B=E7=99=BC=E7=A4=BE=E5=8D=80=E5=90=88=E4=BD=9C= =E3=80=82=E5=AE=83=E8=A9=A6=E5=9C=96=E8=A8=98=E9=8C=84=E9=80=99=E5=80=8B=E7= =A4=BE=E5=8D=80=E5=A6=82=E4=BD=95=E4=BB=A5=E4=B8=80=E7=A8=AE=E4=B8=8D=E7=86= =9F=E6=82=89Linux=E5=85=A7=E6=A0=B8=E9=96=8B=E7=99=BC=EF=BC=88=E6=88=96=E8= =80=85=E5=AF=A6=E9=9A=9B=E4=B8=8A=E6=98=AF=E8=87=AA=E7=94=B1=E8=BB=9F=E9=AB= =94=E9=96=8B=E7=99=BC=EF=BC=89=E7=9A=84=E4=BA=BA=E5=8F=AF=E4=BB=A5=E8=A8=AA= =E5=95=8F=E7=9A=84=E6=96=B9=E5=BC=8F=E5=B7=A5=E4=BD=9C=E3=80=82=E9=9B=96=E7= =84=B6=E9=80=99=E8=A3=A1=E6=9C=89=E4=B8=80=E4=BA=9B=E6=8A=80=E8=A1=93=E8=B3= =87=E6=96=99=EF=BC=8C=E4=BD=86=E9=80=99=E6=98=AF=E4=B8=80=E5=80=8B=E9=9D=A2= =E5=90=91=E9=81=8E=E7=A8=8B=E7=9A=84=E8=A8=8E=E8=AB=96=EF=BC=8C=E4=B8=8D=E9= =9C=80=E8=A6=81=E6=B7=B1=E5=85=A5=E4=BA=86=E8=A7=A3=E5=85=A7=E6=A0=B8=E7=B7= =A8=E7=A8=8B=E5=B0=B1=E5=8F=AF=E4=BB=A5=E7=90=86=E8=A7=A3=E3=80=82 =20 .. toctree:: + :caption: =E5=85=A7=E5=AE=B9 :numbered: :maxdepth: 2 =20 @@ -26,5 +27,3 @@ 7.AdvancedTopics 8.Conclusion =20 -=E6=9C=AC=E6=96=87=E6=AA=94=E7=9A=84=E7=9B=AE=E7=9A=84=E6=98=AF=E5=B9=AB= =E5=8A=A9=E9=96=8B=E7=99=BC=E4=BA=BA=E5=93=A1=EF=BC=88=E5=8F=8A=E5=85=B6=E7= =B6=93=E7=90=86=EF=BC=89=E4=BB=A5=E6=9C=80=E5=B0=8F=E7=9A=84=E6=8C=AB=E6=8A= =98=E6=84=9F=E8=88=87=E9=96=8B=E7=99=BC=E7=A4=BE=E5=8D=80=E5=90=88=E4=BD=9C= =E3=80=82=E5=AE=83=E8=A9=A6=E5=9C=96=E8=A8=98=E9=8C=84=E9=80=99=E5=80=8B=E7= =A4=BE=E5=8D=80=E5=A6=82=E4=BD=95=E4=BB=A5=E4=B8=80=E7=A8=AE=E4=B8=8D=E7=86= =9F=E6=82=89Linux=E5=85=A7=E6=A0=B8=E9=96=8B=E7=99=BC=EF=BC=88=E6=88=96=E8= =80=85=E5=AF=A6=E9=9A=9B=E4=B8=8A=E6=98=AF=E8=87=AA=E7=94=B1=E8=BB=9F=E9=AB= =94=E9=96=8B=E7=99=BC=EF=BC=89=E7=9A=84=E4=BA=BA=E5=8F=AF=E4=BB=A5=E8=A8=AA= =E5=95=8F=E7=9A=84=E6=96=B9=E5=BC=8F=E5=B7=A5=E4=BD=9C=E3=80=82=E9=9B=96=E7= =84=B6=E9=80=99=E8=A3=A1=E6=9C=89=E4=B8=80=E4=BA=9B=E6=8A=80=E8=A1=93=E8=B3= =87=E6=96=99=EF=BC=8C=E4=BD=86=E9=80=99=E6=98=AF=E4=B8=80=E5=80=8B=E9=9D=A2= =E5=90=91=E9=81=8E=E7=A8=8B=E7=9A=84=E8=A8=8E=E8=AB=96=EF=BC=8C=E4=B8=8D=E9= =9C=80=E8=A6=81=E6=B7=B1=E5=85=A5=E4=BA=86=E8=A7=A3=E5=85=A7=E6=A0=B8=E7=B7= =A8=E7=A8=8B=E5=B0=B1=E5=8F=AF=E4=BB=A5=E7=90=86=E8=A7=A3=E3=80=82 - --=20 2.34.1