docs-rst: parse-headers.pl: cleanup the documentation
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 30 Nov 2016 10:00:20 +0000 (08:00 -0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 1 Dec 2016 00:08:09 +0000 (17:08 -0700)
commitc3396656666c2c98db306dc91c480d9fbde35cc9
tree1781dbbb72dd7425a124f8e4205a5a9e42df81fe
parent293fbd4fefec92f5d8e7d8256f9228a9aaf99070
docs-rst: parse-headers.pl: cleanup the documentation

Keeping both rst and in-file documentation in sync can be harsh.

So, simplify the script's internal documntation to a bare minimum,
and add a mention to the ReST file with its full documentation.

This way, a quick help is still available at the command line,
while the complete one is maintained at the ReST format.

As we won't be using pad2rst anymore, do a cleanup at the ReST
file.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/doc-guide/parse-headers.rst
Documentation/sphinx/parse-headers.pl