]> pilppa.com Git - linux-2.6-omap-h63xx.git/commit
[PATCH] kernel-doc: make parameter description indentation uniform
authorRandy Dunlap <rdunlap@xenotime.net>
Wed, 11 Oct 2006 08:22:12 +0000 (01:22 -0700)
committerLinus Torvalds <torvalds@g5.osdl.org>
Wed, 11 Oct 2006 18:14:24 +0000 (11:14 -0700)
commit272057447f646c51bc77c60044eb21c683fa366d
tree096feb88266ec42ff8a2522699214600b3f6a3fc
parentc751c1dbb1289d220a8a175ba0df47706ce95a7e
[PATCH] kernel-doc: make parameter description indentation uniform

- In parameter descriptions, strip all whitespace between the parameter
  name (e.g., @len) and its description so that the description is
  indented uniformly in text and man page modes.  Previously, spaces
  or tabs (which are used for cleaner source code viewing) affected
  the produced output in a negative way.

Before (man mode):
       to            Destination address, in user space.
       from        Source address, in kernel space.
       n              Number of bytes to copy.

After (man mode):
       to          Destination address, in user space.
       from        Source address, in kernel space.
       n           Number of bytes to copy.

- Fix/clarify a few function description comments.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
scripts/kernel-doc