mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Jani Nikula <jani.nikula@intel.com>,
	Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 07/11] docs: Apply some basic organization to the process guide
Date: Wed, 26 Oct 2016 17:19:35 -0600	[thread overview]
Message-ID: <1477523979-5837-8-git-send-email-corbet@lwn.net> (raw)
In-Reply-To: <1477523979-5837-1-git-send-email-corbet@lwn.net>

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

  parent reply	other threads:[~2016-10-26 23:22 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-26 23:19 [PATCH 00/11] Organize and clean up the admin and process guides Jonathan Corbet
2016-10-26 23:19 ` [PATCH 01/11] docs: Tweak the top-level Sphinx page Jonathan Corbet
2016-10-27  0:12   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 02/11] docs: retitle the kernel-documentation.rst Jonathan Corbet
2016-10-27  0:13   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 03/11] docs: Clean up and organize the admin guide a bit Jonathan Corbet
2016-10-27  0:18   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 04/11] docs: Get rid of the badRAM guide Jonathan Corbet
2016-10-27  0:19   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 05/11] docs: Get rid of the "basic profiling" guide Jonathan Corbet
2016-10-27  0:20   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 06/11] docs: Get rid of the "bug-hunting" guide Jonathan Corbet
2016-10-27  0:23   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` Jonathan Corbet [this message]
2016-10-27  0:24   ` [PATCH 07/11] docs: Apply some basic organization to the process guide Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 08/11] docs: Tweak submitting-patches.rst formatting Jonathan Corbet
2016-10-27  0:25   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 09/11] docs: Collapse the process guide TOC Jonathan Corbet
2016-10-27  0:26   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 10/11] docs: add a warning to submitting-drivers.rst Jonathan Corbet
2016-10-27  0:38   ` Mauro Carvalho Chehab
2016-10-26 23:19 ` [PATCH 11/11] docs: Add a warning to applying-patches.rst Jonathan Corbet
2016-10-27  0:32   ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1477523979-5837-8-git-send-email-corbet@lwn.net \
    --to=corbet@lwn.net \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@s-opensource.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®