[PATCH v2 16/20] HOWTO.rst: add cross-references to other documents

From: Mauro Carvalho Chehab
Date: Mon Sep 12 2016 - 22:22:53 EST

The other documents at kernel-development are all mentioned
by HOWTO. Convert those mention to cross-references.

Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
---
Documentation/development-process/Changes.rst | 2 ++
Documentation/development-process/CodingStyle.rst | 1 +
Documentation/development-process/HOWTO.rst | 18 +++++++++---------
Documentation/development-process/ManagementStyle.rst | 2 ++
Documentation/development-process/SecurityBugs.rst | 2 ++
.../development-process/SubmittingDrivers.rst | 2 ++
.../development-process/SubmittingPatches.rst | 1 +
Documentation/development-process/applying-patches.rst | 1 +
Documentation/development-process/kernel-docs.rst | 2 ++
.../development-process/stable_api_nonsense.rst | 2 ++
.../development-process/stable_kernel_rules.rst | 2 ++
11 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/Documentation/development-process/Changes.rst b/Documentation/development-process/Changes.rst
index a9f365d864c7..97f7bf178340 100644
--- a/Documentation/development-process/Changes.rst
+++ b/Documentation/development-process/Changes.rst
@@ -1,3 +1,5 @@
+.. _changes:
+
Minimal requerements to compile the Kernel
++++++++++++++++++++++++++++++++++++++++++

diff --git a/Documentation/development-process/CodingStyle.rst b/Documentation/development-process/CodingStyle.rst
index d9debafbd2eb..510063361b04 100644
--- a/Documentation/development-process/CodingStyle.rst
+++ b/Documentation/development-process/CodingStyle.rst
@@ -1,3 +1,4 @@
+.. _codingstyle:

Linux kernel coding style
=========================
diff --git a/Documentation/development-process/HOWTO.rst b/Documentation/development-process/HOWTO.rst
index 5a85e3a8112b..31c8df5d20c7 100644
--- a/Documentation/development-process/HOWTO.rst
+++ b/Documentation/development-process/HOWTO.rst
@@ -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/development-process/ManagementStyle.rst b/Documentation/development-process/ManagementStyle.rst
index 86c5a19e08f3..f76219cdc869 100644
--- a/Documentation/development-process/ManagementStyle.rst
+++ b/Documentation/development-process/ManagementStyle.rst
@@ -1,3 +1,5 @@
+.. _managementstyle:
+
Linux kernel management style
=============================

diff --git a/Documentation/development-process/SecurityBugs.rst b/Documentation/development-process/SecurityBugs.rst
index 5f61bd4bc8ef..df795e22d08b 100644
--- a/Documentation/development-process/SecurityBugs.rst
+++ b/Documentation/development-process/SecurityBugs.rst
@@ -1,3 +1,5 @@
+.. _securitybugs:
+
Security bugs
=============

diff --git a/Documentation/development-process/SubmittingDrivers.rst b/Documentation/development-process/SubmittingDrivers.rst
index a2f30a9e28d1..2ac931645e53 100644
--- a/Documentation/development-process/SubmittingDrivers.rst
+++ b/Documentation/development-process/SubmittingDrivers.rst
@@ -1,3 +1,5 @@
+.. _submittingdrivers:
+
Submitting Drivers For The Linux Kernel
=======================================

diff --git a/Documentation/development-process/SubmittingPatches.rst b/Documentation/development-process/SubmittingPatches.rst
index f47cea0ff615..d856af3de9f5 100644
--- a/Documentation/development-process/SubmittingPatches.rst
+++ b/Documentation/development-process/SubmittingPatches.rst
@@ -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/development-process/applying-patches.rst b/Documentation/development-process/applying-patches.rst
index 573eb3bee19e..2424f37c3ec5 100644
--- a/Documentation/development-process/applying-patches.rst
+++ b/Documentation/development-process/applying-patches.rst
@@ -1,3 +1,4 @@
+.. _applying_patches:

Applying Patches To The Linux Kernel
++++++++++++++++++++++++++++++++++++
diff --git a/Documentation/development-process/kernel-docs.rst b/Documentation/development-process/kernel-docs.rst
index 7ca806184426..955f5b775e69 100644
--- a/Documentation/development-process/kernel-docs.rst
+++ b/Documentation/development-process/kernel-docs.rst
@@ -1,3 +1,5 @@
+.. _kernel_docs:
+
Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel
=============================================================================================

diff --git a/Documentation/development-process/stable_api_nonsense.rst b/Documentation/development-process/stable_api_nonsense.rst
index 0d375c115b0c..b681de99aae1 100644
--- a/Documentation/development-process/stable_api_nonsense.rst
+++ b/Documentation/development-process/stable_api_nonsense.rst
@@ -1,3 +1,5 @@
+.. _stable_api_nonsense:
+
The Linux Kernel Driver Interface
==================================

diff --git a/Documentation/development-process/stable_kernel_rules.rst b/Documentation/development-process/stable_kernel_rules.rst
index 387d8a44eda2..1eba72708c7f 100644
--- a/Documentation/development-process/stable_kernel_rules.rst
+++ b/Documentation/development-process/stable_kernel_rules.rst
@@ -1,3 +1,5 @@
+.. _stable_kernel_rules:
+
Everything you ever wanted to know about Linux -stable releases
===============================================================

--
2.7.4