summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Brownell <david-b@pacbell.net>2002-04-08 00:05:16 -0700
committerGreg Kroah-Hartman <greg@kroah.com>2002-04-08 00:05:16 -0700
commit3066fa910caf0916fe7cf3eb6c5f9aa5320855e8 (patch)
tree64c932a26a01e4410431bf18b1ab9de75584430e
parentf74682cfe60152bdb8e26028c08092e340eaca49 (diff)
USB kerneldoc fixes
This fixes some kerneldoc bugs for USB. It catches up with the recent rename, and includes a couple minor tweaks/fixes I happened to notice.
-rw-r--r--Documentation/DocBook/Makefile4
-rw-r--r--Documentation/DocBook/kernel-api.tmpl4
-rw-r--r--include/linux/usb.h8
3 files changed, 9 insertions, 7 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index c8f0c981ecac..2e0281850aa2 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -104,8 +104,8 @@ APISOURCES := $(TOPDIR)/drivers/media/video/videodev.c \
$(TOPDIR)/sound/sound_firmware.c \
$(TOPDIR)/drivers/net/wan/syncppp.c \
$(TOPDIR)/drivers/net/wan/z85230.c \
- $(TOPDIR)/drivers/usb/hcd.c \
- $(TOPDIR)/drivers/usb/usb.c \
+ $(TOPDIR)/drivers/usb/core/hcd.c \
+ $(TOPDIR)/drivers/usb/core/usb.c \
$(TOPDIR)/drivers/video/fbmem.c \
$(TOPDIR)/drivers/video/fbcmap.c \
$(TOPDIR)/drivers/video/fbcon.c \
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index 8b7088186c0d..2e783c8b00ed 100644
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -282,7 +282,7 @@
</sect1>
<sect1><title>USB Core APIs</title>
-!Edrivers/usb/usb.c
+!Edrivers/usb/core/usb.c
</sect1>
<sect1><title>Host Controller APIs</title>
@@ -290,7 +290,7 @@
most of which implement standard register interfaces such as
EHCI, OHCI, or UHCI.
</para>
-!Edrivers/usb/hcd.c
+!Edrivers/usb/core/hcd.c
</sect1>
</chapter>
diff --git a/include/linux/usb.h b/include/linux/usb.h
index 2b7b4d39b590..828cf3f50846 100644
--- a/include/linux/usb.h
+++ b/include/linux/usb.h
@@ -471,8 +471,10 @@ struct usb_device_id {
/**
* struct usb_driver - identifies USB driver to usbcore
- * @owner: pointer to the module owner of this driver
- * @name: The driver name should be unique among USB drivers
+ * @owner: Pointer to the module owner of this driver; initialize
+ * it using THIS_MODULE.
+ * @name: The driver name should be unique among USB drivers,
+ * and should normally be the same as the module name.
* @probe: Called to see if the driver is willing to manage a particular
* interface on a device. The probe routine returns a handle that
* will later be provided to disconnect(), or a null pointer to
@@ -507,7 +509,7 @@ struct usb_device_id {
* is used by both user and kernel mode hotplugging support.
*
* The probe() and disconnect() methods are called in a context where
- * they can sleep, but they should avoid abusing the privilage. Most
+ * they can sleep, but they should avoid abusing the privilege. Most
* work to connect to a device should be done when the device is opened,
* and undone at the last close. The disconnect code needs to address
* concurrency issues with respect to open() and close() methods, as