mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-27 12:57:53 +00:00
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
This commit is contained in:
parent
58af664644
commit
2b7703e15a
4 changed files with 22 additions and 26 deletions
|
@ -3,9 +3,17 @@
|
||||||
A guide to the Kernel Development Process
|
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::
|
.. toctree::
|
||||||
|
:caption: Contents
|
||||||
:numbered:
|
:numbered:
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
@ -17,12 +25,3 @@ Contents:
|
||||||
6.Followthrough
|
6.Followthrough
|
||||||
7.AdvancedTopics
|
7.AdvancedTopics
|
||||||
8.Conclusion
|
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.
|
|
||||||
|
|
|
@ -8,9 +8,17 @@
|
||||||
Una guida al processo di sviluppo del Kernel
|
Una guida al processo di sviluppo del Kernel
|
||||||
============================================
|
============================================
|
||||||
|
|
||||||
Contenuti:
|
Lo scopo di questo documento è quello di aiutare gli sviluppatori (ed i loro
|
||||||
|
supervisori) a lavorare con la communità di sviluppo con il minimo sforzo. È
|
||||||
|
un tentativo di documentare il funzionamento di questa communità in modo che
|
||||||
|
sia accessibile anche a coloro che non hanno famigliarità con lo sviluppo del
|
||||||
|
Kernel Linux (o, anzi, con lo sviluppo di software libero in generale). Benchè
|
||||||
|
qui sia presente del materiale tecnico, questa è una discussione rivolta in
|
||||||
|
particolare al procedimento, e quindi per essere compreso non richiede una
|
||||||
|
conoscenza approfondità sullo sviluppo del kernel.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:caption: Contenuti
|
||||||
:numbered:
|
:numbered:
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
@ -22,12 +30,3 @@ Contenuti:
|
||||||
6.Followthrough
|
6.Followthrough
|
||||||
7.AdvancedTopics
|
7.AdvancedTopics
|
||||||
8.Conclusion
|
8.Conclusion
|
||||||
|
|
||||||
Lo scopo di questo documento è quello di aiutare gli sviluppatori (ed i loro
|
|
||||||
supervisori) a lavorare con la communità di sviluppo con il minimo sforzo. È
|
|
||||||
un tentativo di documentare il funzionamento di questa communità in modo che
|
|
||||||
sia accessibile anche a coloro che non hanno famigliarità con lo sviluppo del
|
|
||||||
Kernel Linux (o, anzi, con lo sviluppo di software libero in generale). Benchè
|
|
||||||
qui sia presente del materiale tecnico, questa è una discussione rivolta in
|
|
||||||
particolare al procedimento, e quindi per essere compreso non richiede una
|
|
||||||
conoscenza approfondità sullo sviluppo del kernel.
|
|
||||||
|
|
|
@ -8,9 +8,10 @@
|
||||||
内核开发过程指南
|
内核开发过程指南
|
||||||
================
|
================
|
||||||
|
|
||||||
内容:
|
本文档的目的是帮助开发人员(及其经理)以最小的挫折感与开发社区合作。它试图记录这个社区如何以一种不熟悉Linux内核开发(或者实际上是自由软件开发)的人可以访问的方式工作。虽然这里有一些技术资料,但这是一个面向过程的讨论,不需要深入了解内核编程就可以理解。
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:caption: 内容
|
||||||
:numbered:
|
:numbered:
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
@ -22,5 +23,3 @@
|
||||||
6.Followthrough
|
6.Followthrough
|
||||||
7.AdvancedTopics
|
7.AdvancedTopics
|
||||||
8.Conclusion
|
8.Conclusion
|
||||||
|
|
||||||
本文档的目的是帮助开发人员(及其经理)以最小的挫折感与开发社区合作。它试图记录这个社区如何以一种不熟悉Linux内核开发(或者实际上是自由软件开发)的人可以访问的方式工作。虽然这里有一些技术资料,但这是一个面向过程的讨论,不需要深入了解内核编程就可以理解。
|
|
||||||
|
|
|
@ -11,9 +11,10 @@
|
||||||
內核開發過程指南
|
內核開發過程指南
|
||||||
================
|
================
|
||||||
|
|
||||||
內容:
|
本文檔的目的是幫助開發人員(及其經理)以最小的挫折感與開發社區合作。它試圖記錄這個社區如何以一種不熟悉Linux內核開發(或者實際上是自由軟體開發)的人可以訪問的方式工作。雖然這裡有一些技術資料,但這是一個面向過程的討論,不需要深入了解內核編程就可以理解。
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:caption: 內容
|
||||||
:numbered:
|
:numbered:
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
@ -26,5 +27,3 @@
|
||||||
7.AdvancedTopics
|
7.AdvancedTopics
|
||||||
8.Conclusion
|
8.Conclusion
|
||||||
|
|
||||||
本文檔的目的是幫助開發人員(及其經理)以最小的挫折感與開發社區合作。它試圖記錄這個社區如何以一種不熟悉Linux內核開發(或者實際上是自由軟體開發)的人可以訪問的方式工作。雖然這裡有一些技術資料,但這是一個面向過程的討論,不需要深入了解內核編程就可以理解。
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue