Skip to content

Commit

Permalink
Documentation/process/howto: Mark subsection in suggested format
Browse files Browse the repository at this point in the history
`Specific guidelines for the kernel documentation` section of
`kernel-documentation.rst` suggests to use ``~`` for subsection but
subsections in HOWTO is not marked in the format.  This commit marks
them in the format.

Signed-off-by: SeongJae Park <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
sjp38 authored and Jonathan Corbet committed Nov 8, 2016
1 parent f226e46 commit d80b9d2
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions Documentation/process/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,8 @@ branches. These different branches are:
- the 4.x -next kernel tree for integration tests

4.x kernel tree
-----------------
~~~~~~~~~~~~~~~

4.x kernels are maintained by Linus Torvalds, and can be found on
https://kernel.org in the pub/linux/kernel/v4.x/ directory. Its development
process is as follows:
Expand Down Expand Up @@ -289,7 +290,8 @@ mailing list about kernel releases:
preconceived timeline."*

4.x.y -stable kernel tree
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~

Kernels with 3-part versions are -stable kernels. They contain
relatively small and critical fixes for security problems or significant
regressions discovered in a given 4.x kernel.
Expand All @@ -312,15 +314,17 @@ documents what kinds of changes are acceptable for the -stable tree, and
how the release process works.

4.x -git patches
----------------
~~~~~~~~~~~~~~~~

These are daily snapshots of Linus' kernel tree which are managed in a
git repository (hence the name.) These patches are usually released
daily and represent the current state of Linus' tree. They are more
experimental than -rc kernels since they are generated automatically
without even a cursory glance to see if they are sane.

Subsystem Specific kernel trees and patches
-------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The maintainers of the various kernel subsystems --- and also many
kernel subsystem developers --- expose their current state of
development in source repositories. That way, others can see what is
Expand All @@ -344,7 +348,8 @@ accepted, or rejected. Most of these patchwork sites are listed at
https://patchwork.kernel.org/.

4.x -next kernel tree for integration tests
-------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Before updates from subsystem trees are merged into the mainline 4.x
tree, they need to be integration-tested. For this purpose, a special
testing repository exists into which virtually all subsystem trees are
Expand Down

0 comments on commit d80b9d2

Please sign in to comment.