]> git.kernelconcepts.de Git - karo-tx-linux.git/commit
circular-buffers.txt: standardize document format
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 14 May 2017 11:55:25 +0000 (08:55 -0300)
committerJonathan Corbet <corbet@lwn.net>
Fri, 14 Jul 2017 19:51:29 +0000 (13:51 -0600)
commitf1d8b71c5fefea29ef4ea856e2192c07446e0c98
tree6469633019ab60dd9cad4e513b8f756894150a4b
parentfdefdbca7e3295341aefa13036f1af7fd5401e1d
circular-buffers.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:

- Mark titles with ReST notation;
- comment the contents table;
- Use :Author: tag for authorship;
- mark literal blocks as such;
- use valid numbered list markups;
- Don't capitalize titles.

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