svn commit: r215450 - head/lib/libusb

[Hans Petter Selasky]

Author: hselasky
Date: Thu Nov 18 08:32:47 2010
New Revision: 215450
URL: http://svn.freebsd.org/changeset/base/215450

Log:
  Correct description of the return values of
  the LibUSB v1.0 libusb_control_transfer() function.
  
  PR:		usb/151851
  Submitted by:	HIROSHI OOTA
  Approved by:	thompsa (mentor)

Modified:
  head/lib/libusb/libusb.3

Modified: head/lib/libusb/libusb.3
==============================================================================
--- head/lib/libusb/libusb.3	Thu Nov 18 08:03:40 2010	(r215449)
+++ head/lib/libusb/libusb.3	Thu Nov 18 08:32:47 2010	(r215450)
@@ -26,7 +26,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd October 14, 2010
+.Dd November 18, 2010
 .Dt LIBUSB 3
 .Os
 .Sh NAME
@@ -380,10 +380,15 @@ LIBUSB_ERROR code on failure.
 .Pp
 .Ft int
 .Fn libusb_control_transfer "libusb_device_handle *devh" "uint8_t bmRequestType" "uint8_t bRequest" "uint16_t wValue" "uint16_t wIndex" "unsigned char *data" "uint16_t wLength" "unsigned int timeout"
-Perform a USB control transfer. Returns 0 on success, LIBUSB_ERROR_TIMEOUT 
-if the transfer timeout, LIBUSB_ERROR_PIPE if the control request was not 
-supported, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and 
-LIBUSB_ERROR code on other failure.
+Perform a USB control transfer. Returns the actual number of bytes
+transferred on success in the range from and including zero until and
+including
+.Xa wLength .
+On error a libusb error code is returned, for example
+LIBUSB_ERROR_TIMEOUT if the transfer timeout, LIBUSB_ERROR_PIPE if the
+control request was not supported, LIBUSB_ERROR_NO_DEVICE if the
+device has been disconnected or another LIBUSB_ERROR code on other failures.
+The libusb error codes are always negative.
 .
 .Pp
 .Ft int