diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/Changes | 2 | ||||
| -rw-r--r-- | Documentation/CodingStyle | 2 | ||||
| -rw-r--r-- | Documentation/HOWTO | 18 | ||||
| -rw-r--r-- | Documentation/ManagementStyle | 2 | ||||
| -rw-r--r-- | Documentation/SecurityBugs | 2 | ||||
| -rw-r--r-- | Documentation/SubmittingDrivers | 2 | ||||
| -rw-r--r-- | Documentation/SubmittingPatches | 1 | ||||
| -rw-r--r-- | Documentation/applying-patches.txt | 1 | ||||
| -rw-r--r-- | Documentation/kernel-docs.txt | 2 | ||||
| -rw-r--r-- | Documentation/stable_api_nonsense.txt | 2 | ||||
| -rw-r--r-- | 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 <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 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 --- 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 352771b736cd..9c3dfa7babf3 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 0e873dbf5566..bc113bff86b7 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 9187b4ef4bac..24f5aeecee91 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 =============================================================== |