From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Markus Heiser <markus.heiser@darmarit.de>,
Jonathan Corbet <corbet@lwn.net>,
Jani Nikula <jani.nikula@linux.intel.com>,
LKML <linux-kernel@vger.kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
stable@vger.kernel.org
Subject: [PATCH v3 18/21] Documentation/HOWTO: add cross-references to other documents
Date: Wed, 14 Sep 2016 08:06:47 -0300 [thread overview]
Message-ID: <30057a5b1fe94deb458a19f10d1c300b5d1ec608.1473849886.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1473849886.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1473849886.git.mchehab@s-opensource.com>
Add cross references for the documents mentioned at HOWTO and
are under the Documentation/ directory, using the ReST notation.
It should be noticed that HOWTO also mentions the /README file.
We opted to not touch it, for now, as making it build on
Sphinx would require it to be moved to a Documentation/foo
directory.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/Changes | 2 ++
Documentation/CodingStyle | 1 +
Documentation/HOWTO | 18 +++++++++---------
Documentation/ManagementStyle | 2 ++
Documentation/SecurityBugs | 2 ++
Documentation/SubmittingDrivers | 2 ++
Documentation/SubmittingPatches | 1 +
Documentation/applying-patches.txt | 1 +
Documentation/kernel-docs.txt | 2 ++
Documentation/stable_api_nonsense.txt | 2 ++
Documentation/stable_kernel_rules.txt | 2 ++
11 files changed, 26 insertions(+), 9 deletions(-)
diff --git a/Documentation/Changes b/Documentation/Changes
index a9f365d864c7..97f7bf178340 100644
--- a/Documentation/Changes
+++ b/Documentation/Changes
@@ -1,3 +1,5 @@
+.. _changes:
+
Minimal requerements to compile the Kernel
++++++++++++++++++++++++++++++++++++++++++
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index ef5b84417224..56f4a42922ab 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -1,3 +1,4 @@
+.. _codingstyle:
Linux kernel coding style
=========================
diff --git a/Documentation/HOWTO b/Documentation/HOWTO
index 5a85e3a8112b..31c8df5d20c7 100644
--- a/Documentation/HOWTO
+++ b/Documentation/HOWTO
@@ -90,19 +90,19 @@ required reading:
what is necessary to do to configure and build the kernel. People
who are new to the kernel should start here.
- Documentation/Changes
+ :ref:`Documentation/Changes <changes>`
This file gives a list of the minimum levels of various software
packages that are necessary to build and run the kernel
successfully.
- Documentation/CodingStyle
+ :ref:`Documentation/CodingStyle <codingstyle>`
This describes the Linux kernel coding style, and some of the
rationale behind it. All new code is expected to follow the
guidelines in this document. Most maintainers will only accept
patches if these rules are followed, and many people will only
review code if it is in the proper style.
- Documentation/SubmittingPatches and Documentation/SubmittingDrivers
+ :ref:`Documentation/SubmittingPatches <submittingpatches>` and :ref:`Documentation/SubmittingDrivers <submittingdrivers>`
These files describe in explicit detail how to successfully create
and send a patch, including (but not limited to):
@@ -124,7 +124,7 @@ required reading:
http://linux.yyz.us/patch-format.html
- Documentation/stable_api_nonsense.txt
+ :ref:`Documentation/stable_api_nonsense.txt <stable_api_nonsense>`
This file describes the rationale behind the conscious decision to
not have a stable API within the kernel, including things like:
@@ -137,29 +137,29 @@ required reading:
philosophy and is very important for people moving to Linux from
development on other Operating Systems.
- Documentation/SecurityBugs
+ :ref:`Documentation/SecurityBugs <securitybugs>`
If you feel you have found a security problem in the Linux kernel,
please follow the steps in this document to help notify the kernel
developers, and help solve the issue.
- Documentation/ManagementStyle
+ :ref:`Documentation/ManagementStyle <managementstyle>`
This document describes how Linux kernel maintainers operate and the
shared ethos behind their methodologies. This is important reading
for anyone new to kernel development (or anyone simply curious about
it), as it resolves a lot of common misconceptions and confusion
about the unique behavior of kernel maintainers.
- Documentation/stable_kernel_rules.txt
+ :ref:`Documentation/stable_kernel_rules.txt <stable_kernel_rules>`
This file describes the rules on how the stable kernel releases
happen, and what to do if you want to get a change into one of these
releases.
- Documentation/kernel-docs.txt
+ :ref:`Documentation/kernel-docs.txt <kernel_docs>`
A list of external documentation that pertains to kernel
development. Please consult this list if you do not find what you
are looking for within the in-kernel documentation.
- Documentation/applying-patches.txt
+ :ref:`Documentation/applying-patches.txt <applying_patches>`
A good introduction describing exactly what a patch is and how to
apply it to the different development branches of the kernel.
diff --git a/Documentation/ManagementStyle b/Documentation/ManagementStyle
index 86c5a19e08f3..f76219cdc869 100644
--- a/Documentation/ManagementStyle
+++ b/Documentation/ManagementStyle
@@ -1,3 +1,5 @@
+.. _managementstyle:
+
Linux kernel management style
=============================
diff --git a/Documentation/SecurityBugs b/Documentation/SecurityBugs
index 5f61bd4bc8ef..df795e22d08b 100644
--- a/Documentation/SecurityBugs
+++ b/Documentation/SecurityBugs
@@ -1,3 +1,5 @@
+.. _securitybugs:
+
Security bugs
=============
diff --git a/Documentation/SubmittingDrivers b/Documentation/SubmittingDrivers
index a2f30a9e28d1..2ac931645e53 100644
--- a/Documentation/SubmittingDrivers
+++ b/Documentation/SubmittingDrivers
@@ -1,3 +1,5 @@
+.. _submittingdrivers:
+
Submitting Drivers For The Linux Kernel
=======================================
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index f47cea0ff615..d856af3de9f5 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -1,3 +1,4 @@
+.. _submittingpatches:
How to Get Your Change Into the Linux Kernel or Care And Operation Of Your Linus Torvalds
=========================================================================================
diff --git a/Documentation/applying-patches.txt b/Documentation/applying-patches.txt
index 573eb3bee19e..2424f37c3ec5 100644
--- a/Documentation/applying-patches.txt
+++ b/Documentation/applying-patches.txt
@@ -1,3 +1,4 @@
+.. _applying_patches:
Applying Patches To The Linux Kernel
++++++++++++++++++++++++++++++++++++
diff --git a/Documentation/kernel-docs.txt b/Documentation/kernel-docs.txt
index 7ca806184426..955f5b775e69 100644
--- a/Documentation/kernel-docs.txt
+++ b/Documentation/kernel-docs.txt
@@ -1,3 +1,5 @@
+.. _kernel_docs:
+
Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel
=============================================================================================
diff --git a/Documentation/stable_api_nonsense.txt b/Documentation/stable_api_nonsense.txt
index 0d375c115b0c..b681de99aae1 100644
--- a/Documentation/stable_api_nonsense.txt
+++ b/Documentation/stable_api_nonsense.txt
@@ -1,3 +1,5 @@
+.. _stable_api_nonsense:
+
The Linux Kernel Driver Interface
==================================
diff --git a/Documentation/stable_kernel_rules.txt b/Documentation/stable_kernel_rules.txt
index 387d8a44eda2..1eba72708c7f 100644
--- a/Documentation/stable_kernel_rules.txt
+++ b/Documentation/stable_kernel_rules.txt
@@ -1,3 +1,5 @@
+.. _stable_kernel_rules:
+
Everything you ever wanted to know about Linux -stable releases
===============================================================
--
2.7.4
next prev parent reply other threads:[~2016-09-14 11:14 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-14 11:06 [PATCH v3 00/21] Create a book for Kernel development Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 01/21] doc: development-process: convert it to ReST markup Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 02/21] doc: development-process: rename files to rst Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 03/21] docs-rst: create a book for the development process Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 04/21] Documentation/HOWTO: convert to ReST notation Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 05/21] Documentation/applying-patches.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-09-16 17:10 ` Jonathan Corbet
2016-09-16 17:20 ` Joe Perches
2016-09-16 21:36 ` Mauro Carvalho Chehab
2016-09-16 20:25 ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 06/21] Documentation/Changes: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 07/21] Documentation/CodingStyle: Convert " Mauro Carvalho Chehab
2016-09-16 17:13 ` Jonathan Corbet
2016-09-16 20:34 ` Mauro Carvalho Chehab
2016-09-17 9:58 ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 08/21] Documentation/CodingStyle: use the proper tag for verbatim font Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 09/21] Documentation/CodingStyle: replace underline markups Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 10/21] Documentation/CodingStyle: use the .. note:: markup where needed Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 11/21] Documentation/kernel-docs.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-09-16 17:15 ` Jonathan Corbet
2016-09-16 20:42 ` Mauro Carvalho Chehab
2016-09-16 21:00 ` Jonathan Corbet
2016-09-16 21:28 ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 12/21] Documentation/ManagementStyle: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 13/21] Documentation/SecurityBugs: " Mauro Carvalho Chehab
2016-09-16 17:17 ` Jonathan Corbet
2016-09-16 20:53 ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 14/21] Documentation/stable_api_nonsense.txt: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 15/21] Documentation/stable_kernel_rules.txt: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 16/21] Documentation/SubmittingDrivers: " Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 17/21] Documentation/SubmittingPatches: " Mauro Carvalho Chehab
2016-09-16 17:21 ` Jonathan Corbet
2016-09-16 22:14 ` Mauro Carvalho Chehab
2016-09-14 11:06 ` Mauro Carvalho Chehab [this message]
2016-09-14 11:06 ` [PATCH v3 19/21] docs-rst: move HOWTO and mentioned documents to development-process/ Mauro Carvalho Chehab
2016-09-16 17:23 ` Jonathan Corbet
2016-09-14 11:06 ` [PATCH v3 20/21] doc: adjust references to development-process Mauro Carvalho Chehab
2016-09-16 17:25 ` Jonathan Corbet
2016-09-16 22:21 ` Mauro Carvalho Chehab
2016-09-14 11:06 ` [PATCH v3 21/21] doc-rst: Add the new development-process/ files to Sphinx build 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=30057a5b1fe94deb458a19f10d1c300b5d1ec608.1473849886.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.org \
--cc=stable@vger.kernel.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.