]> git.karo-electronics.de Git - linux-beck.git/commit
kernel-doc/rst: change the output layout
authorJani Nikula <jani.nikula@intel.com>
Thu, 26 May 2016 15:30:27 +0000 (18:30 +0300)
committerJani Nikula <jani.nikula@intel.com>
Mon, 30 May 2016 10:39:00 +0000 (13:39 +0300)
commitecbcfba126e857de8dd4996fe31fad782dd6bae0
tree51464bcf36eaaedcee59b23b4c90dbe5e56c1abd
parent6450c8957ee3a8f58191c2ed6c5b71c7b7d1b310
kernel-doc/rst: change the output layout

Move away from field lists, and simply use **strong emphasis** for
section headings on lines of their own. Do not use rst section headings,
because their nesting depth depends on the surrounding context, which
kernel-doc has no knowledge of. Also, they do not need to end up in any
table of contexts or indexes.

There are two related immediate benefits. Field lists are typically
rendered in two columns, while the new style uses the horizontal width
better. With no extra indent on the left, there's no need to be as fussy
about it. Field lists are more susceptible to indentation problems than
the new style.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
scripts/kernel-doc