Skip to content

Commit

Permalink
docs: Apply some basic organization to the process guide
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Jonathan Corbet committed Oct 27, 2016
1 parent 5700d19 commit 9b4ebd9
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Documentation/process/changes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _changes:

Minimal requerements to compile the Kernel
Minimal requirements to compile the Kernel
++++++++++++++++++++++++++++++++++++++++++

Intro
Expand Down
37 changes: 28 additions & 9 deletions Documentation/process/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 9b4ebd9

Please sign in to comment.