block: document blk-plug
authorSuresh Jayaraman <[email protected]>
Wed, 21 Sep 2011 08:00:16 +0000 (10:00 +0200)
committerJens Axboe <[email protected]>
Wed, 21 Sep 2011 08:00:16 +0000 (10:00 +0200)
commit75df713627f28f88b901b329c8857747545fd4ab
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.

[[email protected]: grammatical and spelling tweaks]
Signed-off-by: Suresh Jayaraman <[email protected]>
Cc: Shaohua Li <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
Signed-off-by: Jens Axboe <[email protected]>
block/blk-core.c
include/linux/blkdev.h