block: document blk-plug
commit75df713627f28f88b901b329c8857747545fd4ab
authorSuresh Jayaraman <sjayaraman@suse.de>
Wed, 21 Sep 2011 08:00:16 +0000 (21 10:00 +0200)
committerJens Axboe <axboe@kernel.dk>
Wed, 21 Sep 2011 08:00:16 +0000 (21 10:00 +0200)
tree0986bc4d82595dae4a3fabb15fce4780c053f004
parent27a84d54c02591e815d291ae0ee4bfb9cfd21065
block: document blk-plug

Thus spake Andrew Morton:

"And I have the usual maintainability whine.  If someone comes up to
vmscan.c and sees it calling blk_start_plug(), how are they supposed to
work out why that call is there?  They go look at the blk_start_plug()
definition and it is undocumented.  I think we can do better than this?"

Adapted from the LWN article - http://lwn.net/Articles/438256/ by Jens
Axboe and from an earlier attempt by Shaohua Li to document blk-plug.

[akpm@linux-foundation.org: grammatical and spelling tweaks]
Signed-off-by: Suresh Jayaraman <sjayaraman@suse.de>
Cc: Shaohua Li <shaohua.li@intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@google.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
block/blk-core.c
include/linux/blkdev.h