From: Phong Tran <tranmanphong@gmail.com>
To: corbet@lwn.net, gregkh@linuxfoundation.org,
skhan@linuxfoundation.org, mchehab@kernel.org
Cc: linux-kernel-mentees@lists.linuxfoundation.org,
linux-usb@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, Phong Tran <tranmanphong@gmail.com>
Subject: [PATCH] Documentation: usb: convert usb-help to rst
Date: Sat, 6 Jul 2019 01:55:19 +0700 [thread overview]
Message-ID: <20190705185519.31033-1-tranmanphong@gmail.com> (raw)
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
next reply other threads:[~2019-07-05 18:55 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-05 18:55 Phong Tran [this message]
2019-07-08 13:52 ` [PATCH] Documentation: usb: convert usb-help to rst Jonathan Corbet
2019-07-08 15:01 ` Phong Tran
2019-07-08 15:16 ` Greg Kroah-Hartman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190705185519.31033-1-tranmanphong@gmail.com \
--to=tranmanphong@gmail.com \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).