[PATCH] virtio_blk.c: Add documentation for vring_enable_cb()

From: Jes . Sorensen
Date: Wed May 19 2010 - 11:51:06 EST

From: Jes Sorensen <Jes.Sorensen@xxxxxxxxxx>


This patch adds a bit of documentation to vring_enable_cb() to make it
crystal clear that the function returns false when there is more work
to do and true when the queue is empty.

I wasted several hours trying to figure out why a piece of code wasn't
working due to this, and I know others hit the same problem. Hopefully
this can save a bit of suffering for others in the future.


Jes Sorensen (1):
Add documentation for vring_enable_cb()

drivers/virtio/virtio_ring.c | 5 +++++
1 files changed, 5 insertions(+), 0 deletions(-)

To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/