]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commitdiff
docs-rst: fix usb cross-references
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 5 Apr 2017 13:23:15 +0000 (10:23 -0300)
committerJonathan Corbet <corbet@lwn.net>
Tue, 11 Apr 2017 20:41:29 +0000 (14:41 -0600)
As some USB documentation files got moved, adjust their
cross-references to their new place.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/ABI/stable/sysfs-bus-usb
Documentation/driver-api/usb/URB.rst
Documentation/driver-api/usb/callbacks.rst
Documentation/driver-api/usb/error-codes.rst
Documentation/driver-api/usb/persist.rst
Documentation/driver-api/usb/power-management.rst
Documentation/driver-api/usb/usb.rst
Documentation/power/swsusp.txt
drivers/staging/most/hdm-usb/hdm_usb.c
drivers/usb/core/Kconfig

index 831f15d9672f29e90cca5650356d2f69599e14b8..b832eeff999914b0afa4e4a99d7379e4f852dea8 100644 (file)
@@ -9,7 +9,7 @@ Description:
                hubs this facility is always enabled and their device
                directories will not contain this file.
 
-               For more information, see Documentation/usb/persist.txt.
+               For more information, see Documentation/driver-api/usb/persist.rst.
 
 What:          /sys/bus/usb/devices/.../power/autosuspend
 Date:          March 2007
index c4a141f29477217804bf1b92c007b12514978911..61a54da9fce94f4d952fdf67c8a311db810cfac0 100644 (file)
@@ -1,3 +1,5 @@
+.. _usb-urb:
+
 USB Request Block (URB)
 ~~~~~~~~~~~~~~~~~~~~~~~
 
index 93a8d53e27e7740e17107125303b1f81d1944728..2b80cf54bcc3118b956a8292aeae8e3af80acf7a 100644 (file)
@@ -8,7 +8,7 @@ Usbcore will call into a driver through callbacks defined in the driver
 structure and through the completion handler of URBs a driver submits.
 Only the former are in the scope of this document. These two kinds of
 callbacks are completely independent of each other. Information on the
-completion callback can be found in Documentation/usb/URB.txt.
+completion callback can be found in :ref:`usb-urb`.
 
 The callbacks defined in the driver structure are:
 
@@ -53,7 +53,7 @@ The callbacks defined in the driver structure are:
 
 The ioctl interface (2) should be used only if you have a very good
 reason. Sysfs is preferred these days. The PM callbacks are covered
-separately in Documentation/usb/power-management.txt.
+separately in :ref:`usb-power-management`.
 
 Calling conventions
 ===================
index 9c11a0fd16cb744801e6e21d85a3f00582145811..a3e84bfac77649bc62a73a3575cb56f3e1645c5d 100644 (file)
@@ -1,3 +1,5 @@
+.. _usb-error-codes:
+
 USB Error codes
 ~~~~~~~~~~~~~~~
 
index ea1b43f0559e4313a5ee092a0b478ac492a6f77e..08cafc6292c1d279da4f65b1f3061748d463602f 100644 (file)
@@ -1,3 +1,5 @@
+.. _usb-persist:
+
 USB device persistence during system suspend
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
index c068257f6d27c80e4bce6a8e388ef78d0ab3e949..79beb807996b7a3a17e08b5f1d6e31d4176d3fc2 100644 (file)
@@ -328,7 +328,7 @@ possible to work around the hibernation-forces-disconnect problem by
 using the USB Persist facility.)
 
 The ``reset_resume`` method is used by the USB Persist facility (see
-``Documentation/usb/persist.txt``) and it can also be used under certain
+:ref:`usb-persist`) and it can also be used under certain
 circumstances when ``CONFIG_USB_PERSIST`` is not enabled.  Currently, if a
 device is reset during a resume and the driver does not have a
 ``reset_resume`` method, the driver won't receive any notification about
index 5ebaf669704cf8234af4719f04c19f9168df4552..6824089ef4c844fed005c6f95b6bffcee74c1ada 100644 (file)
@@ -424,8 +424,8 @@ header.
 Unless noted otherwise, the ioctl requests described here will update
 the modification time on the usbfs file to which they are applied
 (unless they fail). A return of zero indicates success; otherwise, a
-standard USB error code is returned. (These are documented in
-``Documentation/usb/error-codes.txt`` in your kernel sources.)
+standard USB error code is returned (These are documented in
+:ref:`usb-error-codes`).
 
 Each of these files multiplexes access to several I/O streams, one per
 endpoint. Each device has one control endpoint (endpoint zero) which
index 8cc17ca718131656aac98d0946ffa2ecad5a1dc8..9f2f942a01cfa969a06068503625938f7f3569e4 100644 (file)
@@ -406,7 +406,7 @@ Firewire, CompactFlash, MMC, external SATA, or even IDE hotplug bays)
 before suspending; then remount them after resuming.
 
 There is a work-around for this problem.  For more information, see
-Documentation/usb/persist.txt.
+Documentation/driver-api/usb/persist.rst.
 
 Q: Can I suspend-to-disk using a swap partition under LVM?
 
index 65211d1824b72f42f5bacd5e8ededb190d766de3..2bfea9b48366f08c00e934a4f3bda918fb01b9d0 100644 (file)
@@ -490,7 +490,7 @@ static void hdm_write_completion(struct urb *urb)
  * disconnect.  In the interval before the hub driver starts disconnect
  * processing, devices may receive such fault reports for every request.
  *
- * See <https://www.kernel.org/doc/Documentation/usb/error-codes.txt>
+ * See <https://www.kernel.org/doc/Documentation/driver-api/usb/error-codes.rst>
  */
 static void hdm_read_completion(struct urb *urb)
 {
index 0e5a889742b34b5ee6f55597741aeeb70f984527..4d75d9a80001eda9039d853871969938b4b82a41 100644 (file)
@@ -26,7 +26,7 @@ config USB_DEFAULT_PERSIST
          unplugged, causing any mounted filesystems to be lost.  The
          persist feature can still be enabled for individual devices
          through the power/persist sysfs node. See
-         Documentation/usb/persist.txt for more info.
+         Documentation/driver-api/usb/persist.rst for more info.
 
          If you have any questions about this, say Y here, only say N
          if you know exactly what you are doing.