]> git.kernelconcepts.de Git - karo-tx-linux.git/commitdiff
docs: Apply some basic organization to the process guide
authorJonathan Corbet <corbet@lwn.net>
Wed, 26 Oct 2016 22:34:09 +0000 (16:34 -0600)
committerJonathan Corbet <corbet@lwn.net>
Thu, 27 Oct 2016 22:37:11 +0000 (16:37 -0600)
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>
Documentation/process/changes.rst
Documentation/process/index.rst

index 22797a15dc24e2944ec081e480659bccdac0ff8b..56ce6611466568acb99444faa77fe7de8916417d 100644 (file)
@@ -1,6 +1,6 @@
 .. _changes:
 
-Minimal requerements to compile the Kernel
+Minimal requirements to compile the Kernel
 ++++++++++++++++++++++++++++++++++++++++++
 
 Intro
index 6ee818752474a2369840e5b5e0855869f60746a4..0cbc62adbbb1fb433bb59e646f2d703f1342c900 100644 (file)
@@ -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