Skip to contentSkip to conversation

Documentation: RCU: Convert RCU basic concepts to ReST

PATCH Superseded Jiunn Chang 3 participants 3 messages Jun 22, 2019

Subsystems (2)

v1 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/3 Documentation: RCU: Convert RCU basic concepts to ReST

Convert RCU basic concepts and add TOC tree hook.

Signed-off-by Jiunn Chang <c0d1n61at3 at gmail.com>
---
 Documentation/RCU/index.rst | 17 +++++++
 Documentation/RCU/rcu.rst   | 91 +++++++++++++++++++++++++++++++++++++
 Documentation/RCU/rcu.txt   | 89 ------------------------------------
 3 files changed, 108 insertions(+), 89 deletions(-)
 create mode 100644 Documentation/RCU/index.rst
 create mode 100644 Documentation/RCU/rcu.rst
 delete mode 100644 Documentation/RCU/rcu.txt
Documentation/RCU/index.rst new file +17 -0
new file mode 100644
index 000000000000..30d1f2f3133f
@@ -0,0 +1,17 @@
+.. _rcu_concepts:
+
+============
+RCU concepts
+============
+
+.. toctree::
+   :maxdepth: 1
+
+   rcu
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
Documentation/RCU/rcu.rst new file +91 -0

91 lines not on this page · raw message

Documentation/RCU/rcu.txt deleted +0 -89

89 lines not on this page · raw message

Signature · 1 line
2.22.0
maintainer
#1 lore raw

PATCH 1/3 Documentation: RCU: Convert RCU basic concepts to ReST

Quoted 3 lines · On Sat, 22 Jun 2019 02:01:33 -0500 Jiunn Chang <c0d1n61at3 at gmail.com> wrote:

Convert RCU basic concepts and add TOC tree hook.

Signed-off-by Jiunn Chang <c0d1n61at3 at gmail.com>

A few overall comments...

- Hopefully Paul is OK with converting these documents. If not, Paul, now seems like the time to complain :)

- It's good to have a cover letter on a multi-part patch set like this describing the overall project. It's also important to copy patches to a public list. At a minimum, linux-doc would be a good place; I'd suggest linux-kernel as well - it doesn't get enough email and people get lonely there.

- (The part that people get mad at me about): we should think about whether this should remain a top-level directory. I would argue for putting it into the core-api manual, but others may disagree.

Thanks for working to improve our docs! In this case, the conversion itself looks good.

jon

#2 lore raw

PATCH 1/3 Documentation: RCU: Convert RCU basic concepts to ReST

Quoted 11 lines · Jonathan Corbet
Quoted 3 lines · On Sat, 22 Jun 2019 02:01:33 -0500 Jiunn Chang <c0d1n61at3 at gmail.com> wrote:

Convert RCU basic concepts and add TOC tree hook.

Signed-off-by Jiunn Chang <c0d1n61at3 at gmail.com>

A few overall comments...

- Hopefully Paul is OK with converting these documents. If not, Paul, now seems like the time to complain :)

No complaints here!

Quoted 5 lines

- It's good to have a cover letter on a multi-part patch set like this describing the overall project. It's also important to copy patches to a public list. At a minimum, linux-doc would be a good place; I'd suggest linux-kernel as well - it doesn't get enough email and people get lonely there.

Heh! For RCU documentation patches, please also CC rcu at vger.kernel.org.

Quoted 3 lines

- (The part that people get mad at me about): we should think about whether this should remain a top-level directory. I would argue for putting it into the core-api manual, but others may disagree.

Let's worry about that separately.

Quoted 2 lines

Thanks for working to improve our docs! In this case, the conversion itself looks good.

I will do a build and check within the next few days, and will more carefully review your next version of this patch series.

Thanx, Paul