diff options
| author | Vegard Nossum <vegard.nossum@oracle.com> | 2023-10-27 10:18:29 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2023-11-17 21:05:26 +0100 |
| commit | 2b7703e15a55890664e57a7a1395589ef70182c1 (patch) | |
| tree | b3ec0204bb1fa1ab81cf9e34b21a8325c39e32e3 /Documentation/process | |
| parent | media: doc: properly format ToC headings (diff) | |
| download | linux-2b7703e15a55890664e57a7a1395589ef70182c1.tar.xz linux-2b7703e15a55890664e57a7a1395589ef70182c1.zip | |
docs: use toctree :caption: and move introduction
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 <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Alex Shi <alexs@kernel.org>
Cc: Yanteng Si <siyanteng@loongson.cn>
Cc: Hu Haowen <src.res.211@gmail.com>
Cc: workflows@vger.kernel.org
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231027081830.195056-11-vegard.nossum@oracle.com
Diffstat (limited to 'Documentation/process')
| -rw-r--r-- | Documentation/process/development-process.rst | 19 |
1 files changed, 9 insertions, 10 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 ========================================= -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. .. toctree:: + :caption: Contents :numbered: :maxdepth: 2 @@ -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. |