[PATCH] Documentation: usb: convert usb-help to rst

[PATCH] Documentation: usb: convert usb-help to rst

[Phong Tran]

Add new index.rst and change usb-help.txt format
to rst.

Signed-off-by: Phong Tran <tranmanphong@gmail.com>
---
 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%)

diff --git a/Documentation/index.rst b/Documentation/index.rst
index a7566ef62411..4e7498f39063 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -102,6 +102,7 @@ needed).
    vm/index
    bpf/index
    misc-devices/index
+   usb/index
 
 Architecture-specific documentation
 -----------------------------------
diff --git a/Documentation/usb/index.rst b/Documentation/usb/index.rst
new file mode 100644
index 000000000000..5688ceaf0826
--- /dev/null
+++ b/Documentation/usb/index.rst
@@ -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`
diff --git a/Documentation/usb/usb-help.txt b/Documentation/usb/usb-help.rst
similarity index 97%
rename from Documentation/usb/usb-help.txt
rename to Documentation/usb/usb-help.rst
index dc23ecd4d802..03abc4e501ae 100644
--- a/Documentation/usb/usb-help.txt
+++ b/Documentation/usb/usb-help.rst
@@ -1,4 +1,3 @@
-==============
 USB references
 ==============
 
-- 
2.11.0

Re: [PATCH] Documentation: usb: convert usb-help to rst

[Jonathan Corbet]

On Sat,  6 Jul 2019 01:55:19 +0700
Phong Tran <tranmanphong@gmail.com> wrote:

> Add new index.rst and change usb-help.txt format
> to rst.
> 
> Signed-off-by: Phong Tran <tranmanphong@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

Re: [PATCH] Documentation: usb: convert usb-help to rst

[Phong Tran]

On Mon, Jul 8, 2019 at 8:52 PM Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Sat,  6 Jul 2019 01:55:19 +0700
> Phong Tran <tranmanphong@gmail.com> wrote:
>
> > Add new index.rst and change usb-help.txt format
> > to rst.
> >
> > Signed-off-by: Phong Tran <tranmanphong@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.

Re: [PATCH] Documentation: usb: convert usb-help to rst

[Greg Kroah-Hartman]

On Mon, Jul 08, 2019 at 10:01:13PM +0700, Phong Tran wrote:
> On Mon, Jul 8, 2019 at 8:52 PM Jonathan Corbet <corbet@lwn.net> wrote:
> >
> > On Sat,  6 Jul 2019 01:55:19 +0700
> > Phong Tran <tranmanphong@gmail.com> wrote:
> >
> > > Add new index.rst and change usb-help.txt format
> > > to rst.
> > >
> > > Signed-off-by: Phong Tran <tranmanphong@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.

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