usb/core: remove "always" from usb_unlink_urb() kernel doc entry
authorSebastian Andrzej Siewior <bigeasy@linutronix.de>
Wed, 29 Feb 2012 22:04:32 +0000 (23:04 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Sat, 3 Mar 2012 00:22:11 +0000 (16:22 -0800)
commit371f3b49f2cb1a8b6ac09b6b108841ca92349eb1
tree65bb502f1a543963484e985772050a0897baabf8
parent2a5be8783e0016d15e7907ddd212b2c312e196eb
usb/core: remove "always" from usb_unlink_urb() kernel doc entry

The kernel doc entry for usb_unlink_urb() contains the phrase "This
request is always asynchronous.". The "always" leads to the assumption
that the ->complete() callback is not called from within
usb_unlink_urb(). This is not true. The HCD is allowed to call the
->complete() from within ->urb_dequeue() if it is appropriate for the
hardware.
This patch updates the kernel doc so usb-device driver authors make sure
to drop all locks (and make sure it is okay to drop them) which are
acquired by the complete callback before calling usb_unlink_urb().

Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/usb/core/urb.c