lkml.org 
[lkml]   [2016]   [Oct]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 07/11] docs: Apply some basic organization to the process guide
    Date
    Put like documents together, with the essential ones at the top, and split
    the TOC into sections.

    Signed-off-by: Jonathan Corbet <corbet@lwn.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
    \
     
     \ /
      Last update: 2016-10-27 01:22    [W:3.149 / U:0.016 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site