diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2016-10-26 16:34:09 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-10-27 16:37:11 -0600 |
| commit | 9b4ebd98da9112f974a6db58555a33eb1bd7c0b0 (patch) | |
| tree | 67033c1f76512cf9cbe62b5fdba75f9e8096902f | |
| parent | 5700d1974818a98983e018efa01da9bc81b84e1a (diff) | |
| download | linux-9b4ebd98da9112f974a6db58555a33eb1bd7c0b0.tar.gz linux-9b4ebd98da9112f974a6db58555a33eb1bd7c0b0.tar.bz2 linux-9b4ebd98da9112f974a6db58555a33eb1bd7c0b0.zip | |
docs: Apply some basic organization to the process guide
Put like documents together, with the essential ones at the top, and split
the TOC into sections.
Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/process/changes.rst | 2 | ||||
| -rw-r--r-- | Documentation/process/index.rst | 37 |
2 files changed, 29 insertions, 10 deletions
diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst index 22797a15dc24..56ce66114665 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst @@ -1,6 +1,6 @@ .. _changes: -Minimal requerements to compile the Kernel +Minimal requirements to compile the Kernel ++++++++++++++++++++++++++++++++++++++++++ Intro diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst index 6ee818752474..0cbc62adbbb1 100644 --- a/Documentation/process/index.rst +++ b/Documentation/process/index.rst @@ -4,29 +4,48 @@ \renewcommand\thesubsection* -Linux Kernel Development Documentation -====================================== +Working with the kernel development community +============================================= -Contents: +So you want to be a Linux kernel developer? Welcome! While there is a lot +to be learned about the kernel in a technical sense, it is also important +to learn about how our community works. Reading these documents will make +it much easier for you to get your changes merged with a minimum of +trouble. + +Below are the essential guides that every developer should read. .. toctree:: :maxdepth: 2 howto - changes - coding-style + code-of-conflict + development-process submitting-patches + coding-style + email-clients + +Other guides to the community that are of interest to most developers are: + +.. toctree:: + :maxdepth: 2 + + changes submitting-drivers stable-api-nonsense management-style stable-kernel-rules + submit-checklist kernel-docs + +These are some overall technical guides that have been put here for now for +lack of a better place. + +.. toctree:: + :maxdepth: 2 + applying-patches - email-clients - submit-checklist - code-of-conflict adding-syscalls magic-number volatile-considered-harmful - development-process |