]> git.baikalelectronics.ru Git - kernel.git/commit
siphash.txt: standardize document format
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 17 May 2017 10:55:32 +0000 (07:55 -0300)
committerJonathan Corbet <corbet@lwn.net>
Fri, 14 Jul 2017 19:58:06 +0000 (13:58 -0600)
commit6f722c46b938a73b2ce3ebbf01fee5a4e25e38d8
treefcda377a8a4c479f7351d2d0a54a590c389b0fad
parenta4b9e5003d29ef8503bf0c738a3dae30d811fbc0
siphash.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;
- Mark literal blocks;
- Use :Author: for authorship;
- Don't sumerate chapters;
- Adjust identation.

NOTE:

This file has actually two documents inside it, the first
one describing siphash, the second one describing halfsiphash.

It is likely a good idea to split them when it gets moved to
security/ (which is where it probably belongs).

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