Re: [PATCH v4 22/29] Documentation/HOWTO: add cross-references to other documents

[Greg KH]

On Mon, Sep 19, 2016 at 08:07:56AM -0300, Mauro Carvalho Chehab wrote:
> 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 
> ---


Acked-by: Greg Kroah-Hartman 

Re: [PATCH v4 22/29] Documentation/HOWTO: add cross-references to other documents

[Greg KH]

On Mon, Sep 19, 2016 at 08:07:56AM -0300, Mauro Carvalho Chehab wrote:
> 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 
> ---


Acked-by: Greg Kroah-Hartman 

[PATCH v4 22/29] Documentation/HOWTO: add cross-references to other documents

[Mauro Carvalho Chehab]

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 
---
 Documentation/Changes |  2 ++
 Documentation/CodingStyle |  2 ++
 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, 27 insertions(+), 9 deletions(-)

diff --git a/Documentation/Changes b/Documentation/Changes
index 93c8e1c15844..754cd50c1bc6 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 7e30da38bb3a..852253c932fe 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -1,3 +1,5 @@
+.. _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 `
 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 `
 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 ` and 
:ref:`Documentation/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 `
 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 `
 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 `
 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 `
 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 `
 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 `
 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 1471df6015a2..dea2e66c9a10 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 

[PATCH v4 22/29] Documentation/HOWTO: add cross-references to other documents

[Mauro Carvalho Chehab]

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 
---
 Documentation/Changes |  2 ++
 Documentation/CodingStyle |  2 ++
 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, 27 insertions(+), 9 deletions(-)

diff --git a/Documentation/Changes b/Documentation/Changes
index 93c8e1c15844..754cd50c1bc6 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 7e30da38bb3a..852253c932fe 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -1,3 +1,5 @@
+.. _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 `
 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 `
 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 ` and 
:ref:`Documentation/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 `
 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 `
 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 `
 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 `
 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 `
 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 `
 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 1471df6015a2..dea2e66c9a10 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 10a1f79376a2..342d769834f6 100644
---