diff options
author | SeongJae Park <sj38.park@gmail.com> | 2016-10-31 16:27:10 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-11-07 19:03:50 -0500 |
commit | d80b9d2aba35d2c9c030c77ad463454c077959ea (patch) | |
tree | 17318909752a84e8b9153d361fe4479d4fe530db /Documentation/process/howto.rst | |
parent | f226e460875da8e00febf55e5ec3438e498ca676 (diff) |
Documentation/process/howto: Mark subsection in suggested format
`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 <sj38.park@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/process/howto.rst')
-rw-r--r-- | Documentation/process/howto.rst | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst index 3f66a1980726..449ca1f199f4 100644 --- a/Documentation/process/howto.rst +++ b/Documentation/process/howto.rst | |||
@@ -254,7 +254,8 @@ branches. These different branches are: | |||
254 | - the 4.x -next kernel tree for integration tests | 254 | - the 4.x -next kernel tree for integration tests |
255 | 255 | ||
256 | 4.x kernel tree | 256 | 4.x kernel tree |
257 | ----------------- | 257 | ~~~~~~~~~~~~~~~ |
258 | |||
258 | 4.x kernels are maintained by Linus Torvalds, and can be found on | 259 | 4.x kernels are maintained by Linus Torvalds, and can be found on |
259 | https://kernel.org in the pub/linux/kernel/v4.x/ directory. Its development | 260 | https://kernel.org in the pub/linux/kernel/v4.x/ directory. Its development |
260 | process is as follows: | 261 | process is as follows: |
@@ -289,7 +290,8 @@ mailing list about kernel releases: | |||
289 | preconceived timeline."* | 290 | preconceived timeline."* |
290 | 291 | ||
291 | 4.x.y -stable kernel tree | 292 | 4.x.y -stable kernel tree |
292 | ------------------------- | 293 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
294 | |||
293 | Kernels with 3-part versions are -stable kernels. They contain | 295 | Kernels with 3-part versions are -stable kernels. They contain |
294 | relatively small and critical fixes for security problems or significant | 296 | relatively small and critical fixes for security problems or significant |
295 | regressions discovered in a given 4.x kernel. | 297 | regressions discovered in a given 4.x kernel. |
@@ -312,7 +314,8 @@ documents what kinds of changes are acceptable for the -stable tree, and | |||
312 | how the release process works. | 314 | how the release process works. |
313 | 315 | ||
314 | 4.x -git patches | 316 | 4.x -git patches |
315 | ---------------- | 317 | ~~~~~~~~~~~~~~~~ |
318 | |||
316 | These are daily snapshots of Linus' kernel tree which are managed in a | 319 | These are daily snapshots of Linus' kernel tree which are managed in a |
317 | git repository (hence the name.) These patches are usually released | 320 | git repository (hence the name.) These patches are usually released |
318 | daily and represent the current state of Linus' tree. They are more | 321 | daily and represent the current state of Linus' tree. They are more |
@@ -320,7 +323,8 @@ experimental than -rc kernels since they are generated automatically | |||
320 | without even a cursory glance to see if they are sane. | 323 | without even a cursory glance to see if they are sane. |
321 | 324 | ||
322 | Subsystem Specific kernel trees and patches | 325 | Subsystem Specific kernel trees and patches |
323 | ------------------------------------------- | 326 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
327 | |||
324 | The maintainers of the various kernel subsystems --- and also many | 328 | The maintainers of the various kernel subsystems --- and also many |
325 | kernel subsystem developers --- expose their current state of | 329 | kernel subsystem developers --- expose their current state of |
326 | development in source repositories. That way, others can see what is | 330 | development in source repositories. That way, others can see what is |
@@ -344,7 +348,8 @@ accepted, or rejected. Most of these patchwork sites are listed at | |||
344 | https://patchwork.kernel.org/. | 348 | https://patchwork.kernel.org/. |
345 | 349 | ||
346 | 4.x -next kernel tree for integration tests | 350 | 4.x -next kernel tree for integration tests |
347 | ------------------------------------------- | 351 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
352 | |||
348 | Before updates from subsystem trees are merged into the mainline 4.x | 353 | Before updates from subsystem trees are merged into the mainline 4.x |
349 | tree, they need to be integration-tested. For this purpose, a special | 354 | tree, they need to be integration-tested. For this purpose, a special |
350 | testing repository exists into which virtually all subsystem trees are | 355 | testing repository exists into which virtually all subsystem trees are |