mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-01-17 10:26:09 +00:00
Documentation/HOWTO: add cross-references to other documents
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> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
9e03ea7f68
commit
609d99a3b7
@ -1,3 +1,5 @@
|
|||||||
|
.. _changes:
|
||||||
|
|
||||||
Minimal requerements to compile the Kernel
|
Minimal requerements to compile the Kernel
|
||||||
++++++++++++++++++++++++++++++++++++++++++
|
++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _codingstyle:
|
||||||
|
|
||||||
Linux kernel coding style
|
Linux kernel coding style
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
|
@ -90,19 +90,19 @@ required reading:
|
|||||||
what is necessary to do to configure and build the kernel. People
|
what is necessary to do to configure and build the kernel. People
|
||||||
who are new to the kernel should start here.
|
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
|
This file gives a list of the minimum levels of various software
|
||||||
packages that are necessary to build and run the kernel
|
packages that are necessary to build and run the kernel
|
||||||
successfully.
|
successfully.
|
||||||
|
|
||||||
Documentation/CodingStyle
|
:ref:`Documentation/CodingStyle <codingstyle>`
|
||||||
This describes the Linux kernel coding style, and some of the
|
This describes the Linux kernel coding style, and some of the
|
||||||
rationale behind it. All new code is expected to follow the
|
rationale behind it. All new code is expected to follow the
|
||||||
guidelines in this document. Most maintainers will only accept
|
guidelines in this document. Most maintainers will only accept
|
||||||
patches if these rules are followed, and many people will only
|
patches if these rules are followed, and many people will only
|
||||||
review code if it is in the proper style.
|
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
|
These files describe in explicit detail how to successfully create
|
||||||
and send a patch, including (but not limited to):
|
and send a patch, including (but not limited to):
|
||||||
|
|
||||||
@ -124,7 +124,7 @@ required reading:
|
|||||||
|
|
||||||
http://linux.yyz.us/patch-format.html
|
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
|
This file describes the rationale behind the conscious decision to
|
||||||
not have a stable API within the kernel, including things like:
|
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
|
philosophy and is very important for people moving to Linux from
|
||||||
development on other Operating Systems.
|
development on other Operating Systems.
|
||||||
|
|
||||||
Documentation/SecurityBugs
|
:ref:`Documentation/SecurityBugs <securitybugs>`
|
||||||
If you feel you have found a security problem in the Linux kernel,
|
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
|
please follow the steps in this document to help notify the kernel
|
||||||
developers, and help solve the issue.
|
developers, and help solve the issue.
|
||||||
|
|
||||||
Documentation/ManagementStyle
|
:ref:`Documentation/ManagementStyle <managementstyle>`
|
||||||
This document describes how Linux kernel maintainers operate and the
|
This document describes how Linux kernel maintainers operate and the
|
||||||
shared ethos behind their methodologies. This is important reading
|
shared ethos behind their methodologies. This is important reading
|
||||||
for anyone new to kernel development (or anyone simply curious about
|
for anyone new to kernel development (or anyone simply curious about
|
||||||
it), as it resolves a lot of common misconceptions and confusion
|
it), as it resolves a lot of common misconceptions and confusion
|
||||||
about the unique behavior of kernel maintainers.
|
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
|
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
|
happen, and what to do if you want to get a change into one of these
|
||||||
releases.
|
releases.
|
||||||
|
|
||||||
Documentation/kernel-docs.txt
|
:ref:`Documentation/kernel-docs.txt <kernel_docs>`
|
||||||
A list of external documentation that pertains to kernel
|
A list of external documentation that pertains to kernel
|
||||||
development. Please consult this list if you do not find what you
|
development. Please consult this list if you do not find what you
|
||||||
are looking for within the in-kernel documentation.
|
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
|
A good introduction describing exactly what a patch is and how to
|
||||||
apply it to the different development branches of the kernel.
|
apply it to the different development branches of the kernel.
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _managementstyle:
|
||||||
|
|
||||||
Linux kernel management style
|
Linux kernel management style
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _securitybugs:
|
||||||
|
|
||||||
Security bugs
|
Security bugs
|
||||||
=============
|
=============
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _submittingdrivers:
|
||||||
|
|
||||||
Submitting Drivers For The Linux Kernel
|
Submitting Drivers For The Linux Kernel
|
||||||
=======================================
|
=======================================
|
||||||
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. _submittingpatches:
|
||||||
|
|
||||||
How to Get Your Change Into the Linux Kernel or Care And Operation Of Your Linus Torvalds
|
How to Get Your Change Into the Linux Kernel or Care And Operation Of Your Linus Torvalds
|
||||||
=========================================================================================
|
=========================================================================================
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. _applying_patches:
|
||||||
|
|
||||||
Applying Patches To The Linux Kernel
|
Applying Patches To The Linux Kernel
|
||||||
++++++++++++++++++++++++++++++++++++
|
++++++++++++++++++++++++++++++++++++
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _kernel_docs:
|
||||||
|
|
||||||
Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel
|
Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel
|
||||||
=============================================================================================
|
=============================================================================================
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _stable_api_nonsense:
|
||||||
|
|
||||||
The Linux Kernel Driver Interface
|
The Linux Kernel Driver Interface
|
||||||
==================================
|
==================================
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _stable_kernel_rules:
|
||||||
|
|
||||||
Everything you ever wanted to know about Linux -stable releases
|
Everything you ever wanted to know about Linux -stable releases
|
||||||
===============================================================
|
===============================================================
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user