diff options
author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-06-18 18:05:38 -0300 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2019-06-20 14:28:36 +0200 |
commit | ecefae6db042283bf88ef3777f2381b18df8ed46 (patch) | |
tree | 5177129d720add73008eeadd6581fab7c27f5233 /Documentation | |
parent | 743344a952fcebee9ca4d783807cf1f03f933baf (diff) | |
download | linux-ecefae6db042283bf88ef3777f2381b18df8ed46.tar.bz2 |
docs: usb: rename files to .rst and add them to drivers-api
While there are a mix of things here, most of the stuff
were written from Kernel developer's PoV. So, add them to
the driver-api book.
A follow up for this patch would be to move documents from
there that are specific to sysadmins, adding them to the
admin-guide.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Johan Hovold <johan@kernel.org>
Acked-by: Felipe Balbi <felipe.balbi@linux.intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/index.rst | 1 | ||||
-rw-r--r-- | Documentation/index.rst.rej | 10 | ||||
-rw-r--r-- | Documentation/usb/acm.rst (renamed from Documentation/usb/acm.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/authorization.rst (renamed from Documentation/usb/authorization.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/chipidea.rst (renamed from Documentation/usb/chipidea.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/dwc3.rst (renamed from Documentation/usb/dwc3.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/ehci.rst (renamed from Documentation/usb/ehci.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/functionfs.rst (renamed from Documentation/usb/functionfs.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/gadget-testing.rst (renamed from Documentation/usb/gadget-testing.txt) | 4 | ||||
-rw-r--r-- | Documentation/usb/gadget_configfs.rst (renamed from Documentation/usb/gadget_configfs.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/gadget_hid.rst (renamed from Documentation/usb/gadget_hid.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/gadget_multi.rst (renamed from Documentation/usb/gadget_multi.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/gadget_printer.rst (renamed from Documentation/usb/gadget_printer.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/gadget_serial.rst (renamed from Documentation/usb/gadget_serial.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/index.rst | 39 | ||||
-rw-r--r-- | Documentation/usb/iuu_phoenix.rst (renamed from Documentation/usb/iuu_phoenix.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/mass-storage.rst (renamed from Documentation/usb/mass-storage.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/misc_usbsevseg.rst (renamed from Documentation/usb/misc_usbsevseg.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/mtouchusb.rst (renamed from Documentation/usb/mtouchusb.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/ohci.rst (renamed from Documentation/usb/ohci.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/rio.rst (renamed from Documentation/usb/rio.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/text_files.rst | 29 | ||||
-rw-r--r-- | Documentation/usb/usb-help.rst (renamed from Documentation/usb/usb-help.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/usb-serial.rst (renamed from Documentation/usb/usb-serial.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/usbip_protocol.rst (renamed from Documentation/usb/usbip_protocol.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/usbmon.rst (renamed from Documentation/usb/usbmon.txt) | 0 | ||||
-rw-r--r-- | Documentation/usb/wusb-design-overview.rst (renamed from Documentation/usb/WUSB-Design-overview.txt) | 0 |
27 files changed, 81 insertions, 2 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst index a7566ef62411..91055adde327 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -101,6 +101,7 @@ needed). filesystems/index vm/index bpf/index + usb/index misc-devices/index Architecture-specific documentation diff --git a/Documentation/index.rst.rej b/Documentation/index.rst.rej new file mode 100644 index 000000000000..b1af6eab22f3 --- /dev/null +++ b/Documentation/index.rst.rej @@ -0,0 +1,10 @@ +--- Documentation/index.rst ++++ Documentation/index.rst +@@ -103,6 +103,7 @@ needed). + vm/index + bpf/index + PCI/index ++ usb/index + misc-devices/index + + Architecture-specific documentation diff --git a/Documentation/usb/acm.txt b/Documentation/usb/acm.rst index e8bda98e9b51..e8bda98e9b51 100644 --- a/Documentation/usb/acm.txt +++ b/Documentation/usb/acm.rst diff --git a/Documentation/usb/authorization.txt b/Documentation/usb/authorization.rst index 9e53909d04c2..9e53909d04c2 100644 --- a/Documentation/usb/authorization.txt +++ b/Documentation/usb/authorization.rst diff --git a/Documentation/usb/chipidea.txt b/Documentation/usb/chipidea.rst index 68473abe2823..68473abe2823 100644 --- a/Documentation/usb/chipidea.txt +++ b/Documentation/usb/chipidea.rst diff --git a/Documentation/usb/dwc3.txt b/Documentation/usb/dwc3.rst index f94a7ba16573..f94a7ba16573 100644 --- a/Documentation/usb/dwc3.txt +++ b/Documentation/usb/dwc3.rst diff --git a/Documentation/usb/ehci.txt b/Documentation/usb/ehci.rst index 31f650e7c1b4..31f650e7c1b4 100644 --- a/Documentation/usb/ehci.txt +++ b/Documentation/usb/ehci.rst diff --git a/Documentation/usb/functionfs.txt b/Documentation/usb/functionfs.rst index 7fdc6d840ac5..7fdc6d840ac5 100644 --- a/Documentation/usb/functionfs.txt +++ b/Documentation/usb/functionfs.rst diff --git a/Documentation/usb/gadget-testing.txt b/Documentation/usb/gadget-testing.rst index 7d7f2340af42..2eeb3e9299e4 100644 --- a/Documentation/usb/gadget-testing.txt +++ b/Documentation/usb/gadget-testing.rst @@ -254,7 +254,7 @@ Device: - connect the gadget to a host, preferably not the one used to control the gadget - run a program which writes to /dev/hidg<N>, e.g. - a userspace program found in Documentation/usb/gadget_hid.txt:: + a userspace program found in Documentation/usb/gadget_hid.rst:: $ ./hid_gadget_test /dev/hidg0 keyboard @@ -886,7 +886,7 @@ host:: # cat /dev/usb/lp0 More advanced testing can be done with the prn_example -described in Documentation/usb/gadget_printer.txt. +described in Documentation/usb/gadget_printer.rst. 20. UAC1 function (virtual ALSA card, using u_audio API) diff --git a/Documentation/usb/gadget_configfs.txt b/Documentation/usb/gadget_configfs.rst index 54fb08baae22..54fb08baae22 100644 --- a/Documentation/usb/gadget_configfs.txt +++ b/Documentation/usb/gadget_configfs.rst diff --git a/Documentation/usb/gadget_hid.txt b/Documentation/usb/gadget_hid.rst index 098d563040cc..098d563040cc 100644 --- a/Documentation/usb/gadget_hid.txt +++ b/Documentation/usb/gadget_hid.rst diff --git a/Documentation/usb/gadget_multi.txt b/Documentation/usb/gadget_multi.rst index 9806b55af301..9806b55af301 100644 --- a/Documentation/usb/gadget_multi.txt +++ b/Documentation/usb/gadget_multi.rst diff --git a/Documentation/usb/gadget_printer.txt b/Documentation/usb/gadget_printer.rst index 5e5516c69075..5e5516c69075 100644 --- a/Documentation/usb/gadget_printer.txt +++ b/Documentation/usb/gadget_printer.rst diff --git a/Documentation/usb/gadget_serial.txt b/Documentation/usb/gadget_serial.rst index dce8bc1fb1f2..dce8bc1fb1f2 100644 --- a/Documentation/usb/gadget_serial.txt +++ b/Documentation/usb/gadget_serial.rst diff --git a/Documentation/usb/index.rst b/Documentation/usb/index.rst new file mode 100644 index 000000000000..e55386a4abfb --- /dev/null +++ b/Documentation/usb/index.rst @@ -0,0 +1,39 @@ +=========== +USB support +=========== + +.. toctree:: + :maxdepth: 1 + + acm + authorization + chipidea + dwc3 + ehci + functionfs + gadget_configfs + gadget_hid + gadget_multi + gadget_printer + gadget_serial + gadget-testing + iuu_phoenix + mass-storage + misc_usbsevseg + mtouchusb + ohci + rio + usbip_protocol + usbmon + usb-serial + wusb-design-overview + + usb-help + text_files + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` diff --git a/Documentation/usb/iuu_phoenix.txt b/Documentation/usb/iuu_phoenix.rst index b76268728450..b76268728450 100644 --- a/Documentation/usb/iuu_phoenix.txt +++ b/Documentation/usb/iuu_phoenix.rst diff --git a/Documentation/usb/mass-storage.txt b/Documentation/usb/mass-storage.rst index d181b47c3cb6..d181b47c3cb6 100644 --- a/Documentation/usb/mass-storage.txt +++ b/Documentation/usb/mass-storage.rst diff --git a/Documentation/usb/misc_usbsevseg.txt b/Documentation/usb/misc_usbsevseg.rst index 6274aee083ed..6274aee083ed 100644 --- a/Documentation/usb/misc_usbsevseg.txt +++ b/Documentation/usb/misc_usbsevseg.rst diff --git a/Documentation/usb/mtouchusb.txt b/Documentation/usb/mtouchusb.rst index d1111b74bf75..d1111b74bf75 100644 --- a/Documentation/usb/mtouchusb.txt +++ b/Documentation/usb/mtouchusb.rst diff --git a/Documentation/usb/ohci.txt b/Documentation/usb/ohci.rst index bb3c49719e6b..bb3c49719e6b 100644 --- a/Documentation/usb/ohci.txt +++ b/Documentation/usb/ohci.rst diff --git a/Documentation/usb/rio.txt b/Documentation/usb/rio.rst index ea73475471db..ea73475471db 100644 --- a/Documentation/usb/rio.txt +++ b/Documentation/usb/rio.rst diff --git a/Documentation/usb/text_files.rst b/Documentation/usb/text_files.rst new file mode 100644 index 000000000000..6a8d3fcf64b6 --- /dev/null +++ b/Documentation/usb/text_files.rst @@ -0,0 +1,29 @@ +Linux CDC ACM inf +----------------- + +.. include:: linux-cdc-acm.inf + :literal: + +Linux inf +--------- + +.. include:: linux.inf + :literal: + +USB devfs drop permissions source +--------------------------------- + +.. literalinclude:: usbdevfs-drop-permissions.c + :language: c + +WUSB command line script to manipulate auth credentials +------------------------------------------------------- + +.. literalinclude:: wusb-cbaf + :language: shell + +Credits +------- + +.. include:: CREDITS + :literal: diff --git a/Documentation/usb/usb-help.txt b/Documentation/usb/usb-help.rst index dc23ecd4d802..dc23ecd4d802 100644 --- a/Documentation/usb/usb-help.txt +++ b/Documentation/usb/usb-help.rst diff --git a/Documentation/usb/usb-serial.txt b/Documentation/usb/usb-serial.rst index 8fa7dbd3da9a..8fa7dbd3da9a 100644 --- a/Documentation/usb/usb-serial.txt +++ b/Documentation/usb/usb-serial.rst diff --git a/Documentation/usb/usbip_protocol.txt b/Documentation/usb/usbip_protocol.rst index 988c832166cd..988c832166cd 100644 --- a/Documentation/usb/usbip_protocol.txt +++ b/Documentation/usb/usbip_protocol.rst diff --git a/Documentation/usb/usbmon.txt b/Documentation/usb/usbmon.rst index b0bd51080799..b0bd51080799 100644 --- a/Documentation/usb/usbmon.txt +++ b/Documentation/usb/usbmon.rst diff --git a/Documentation/usb/WUSB-Design-overview.txt b/Documentation/usb/wusb-design-overview.rst index dc5e21609bb5..dc5e21609bb5 100644 --- a/Documentation/usb/WUSB-Design-overview.txt +++ b/Documentation/usb/wusb-design-overview.rst |