OSDN Git Service

kernel-per-CPU-kthreads.txt: standardize document format
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 14 May 2017 19:07:16 +0000 (16:07 -0300)
committerJonathan Corbet <corbet@lwn.net>
Fri, 14 Jul 2017 19:51:43 +0000 (13:51 -0600)
commit7d98c21bd0257ec9f56910c758519bee71767517
tree97544d32bbb2ad4c378c1e8b9f94ee74a58f5cdf
parent0685552f2c37531eb2f29faf7918a15b632175c5
kernel-per-CPU-kthreads.txt: standardize document format

Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Use title markups;
- use "-" for bulletted lists;
- Split Name/Purpose on two lines, in order to make visually
  easier to read (in text format), and to bold the title
  (on ReST output)
- Add blank lines to split bulleted lists;
- use sub-titles for the several kthread softirq types;
- mark one literal var with asterisk as such, in order to
  avoid an error warning on Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/kernel-per-CPU-kthreads.txt