3 Commits

Author	SHA1	Message	Date
Mauro Carvalho Chehab	c339665666	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>	2016-11-30 17:08:09 -07:00
Mauro Carvalho Chehab	2dde123b23	parse-headers.rst: add an introduction to the man page ... The pod2rst tool generated a man page for parse-headers.pl script, but it is better to put it into some context. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>	2016-11-19 10:22:15 -07:00
Mauro Carvalho Chehab	327f5a754a	parse-headers.pl: add documentation for this script ... Provide a man page for parse-headers.pl, describing how to use it. The documentation on ReST format was generated via pod2rst: http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rst Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>	2016-11-19 10:22:08 -07:00