block: clarify documentation for blk_{start|finish}_plug
authorJeff Moyer <jmoyer@redhat.com>
Tue, 8 Jan 2019 21:57:34 +0000 (16:57 -0500)
committerJens Axboe <axboe@kernel.dk>
Wed, 9 Jan 2019 03:49:46 +0000 (20:49 -0700)
commit40405851af73c59678ffd8f490e6b288c7fbaf29
tree2197e07a0186f0da94970382fbeb85d5b11ebe00
parent373282e7ab6840cd583a223fa90628f2d8293c26
block: clarify documentation for blk_{start|finish}_plug

There was some confusion about what these functions did.  Make it clear
that this is a hint for upper layers to pass to the block layer, and
that it does not guarantee that I/O will not be submitted between a
start and finish plug.

Reported-by: "Darrick J. Wong" <darrick.wong@oracle.com>
Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Ming Lei <ming.lei@redhat.com>
Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
block/blk-core.c