From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933253AbcINLOk (ORCPT ); Wed, 14 Sep 2016 07:14:40 -0400 Received: from bombadil.infradead.org ([198.137.202.9]:40260 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1761607AbcINLM6 (ORCPT ); Wed, 14 Sep 2016 07:12:58 -0400 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , Markus Heiser , Jonathan Corbet , Jani Nikula , LKML , Greg Kroah-Hartman , 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 Message-Id: <30057a5b1fe94deb458a19f10d1c300b5d1ec608.1473849886.git.mchehab@s-opensource.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 | 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 ` 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 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