linux-kernel - [PATCH 07/11] docs: Apply some basic organization to the process guide

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 26 Oct 2016 17:19:35 -0600
From:   Jonathan Corbet <corbet@....net>
To:     linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, Jani Nikula <jani.nikula@...el.com>,
        Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Jonathan Corbet <corbet@....net>
Subject: [PATCH 07/11] 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.

Signed-off-by: Jonathan Corbet <corbet@....net>
---
 Documentation/process/changes.rst |  2 +-
 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
-- 
2.7.4