Documentation: usb: convert usb-help to rst
Subsystems (2)
PATCH 1/1 Documentation: usb: convert usb-help to rst
Add new index.rst and change usb-help.txt format
to rst.
---
Documentation/index.rst | 1 +
Documentation/usb/index.rst | 22 ++++++++++++++++++++++
Documentation/usb/{usb-help.txt => usb-help.rst} | 1 -
3 files changed, 23 insertions(+), 1 deletion(-)
create mode 100644 Documentation/usb/index.rst
rename Documentation/usb/{usb-help.txt => usb-help.rst} (97%)Documentation/index.rst +1 -0
@@ -102,6 +102,7 @@ needed). vm/index bpf/index misc-devices/index + usb/index Architecture-specific documentation -----------------------------------
Documentation/usb/index.rst new file +22 -0
@@ -0,0 +1,22 @@ +.. SPDX-License-Identifier: GPL-2.0 + +Linux USB Subsystem Documentation +=================================== + +.. only:: html + + .. class:: toc-title + + Table of Contents + +.. toctree:: + :maxdepth: 2 + + usb-help + +.. only:: html and subproject + + Indices + ======= + + * :ref:`genindex`
Documentation/usb/usb-help.rst renamed from Documentation/usb/usb-help.txt +0 -1
@@ -1,4 +1,3 @@ -============== USB references ==============
Signature · 1 line
2.11.0
Jonathan Corbet
maintainerQuoted 4 lines · On Sat, 6 Jul 2019 01:55:19 +0700 Phong Tran <tranmanphong at gmail.com> wrote:
Add new
index.rstand change usb-help.txt format
to rst.Signed-off-by Phong Tran <tranmanphong at gmail.com>
Thank you for working to make the kernel's documentation better. That said, I really don't think there is value in keeping this document. It hasn't been updated in any useful way in decades, contains broken links, and the links that still work are full of obsolete information. Honestly, a better patch would, IMO, just delete this file.
Thanks,
jon
Quoted 7 lines · Jonathan Corbet
Quoted 3 lines · On Sat, 6 Jul 2019 01:55:19 +0700 Phong Tran <tranmanphong at gmail.com> wrote:
Add new
index.rstand change usb-help.txt format
to rst.
Quoted 8 lines
Quoted 1 line
Signed-off-by Phong Tran <tranmanphong at gmail.com>Thank you for working to make the kernel's documentation better. That said, I really don't think there is value in keeping this document. It hasn't been updated in any useful way in decades, contains broken links, and the links that still work are full of obsolete information. Honestly, a better patch would, IMO, just delete this file.
@Jonathan Corbet it's fine to me.
Need ack from you @Greg Kroah-Hartman
if yes, I will send the cleanup patch.
Regards,
Phong.
Greg Kroah-Hartman
maintainerQuoted 16 lines · Phong Tran
Quoted 7 lines · Jonathan Corbet
Quoted 3 lines · On Sat, 6 Jul 2019 01:55:19 +0700 Phong Tran <tranmanphong at gmail.com> wrote:
Add new
index.rstand change usb-help.txt format
to rst.Quoted 8 lines
Quoted 1 line
Signed-off-by Phong Tran <tranmanphong at gmail.com>Thank you for working to make the kernel's documentation better. That said, I really don't think there is value in keeping this document. It hasn't been updated in any useful way in decades, contains broken links, and the links that still work are full of obsolete information. Honestly, a better patch would, IMO, just delete this file.
Quoted 4 lines
@Jonathan Corbet it's fine to me.
Need ack from you @Greg Kroah-Hartman
if yes, I will send the cleanup patch.
All of the USB documentation needs a refresh and look again at where it is and what it contains. After 5.3-rc1 I would recommend doing that (as that is when all of the recent pending documentation changes will be merged).
thanks,
greg k-h