Skip to content

Manually convert RCU text files to ReST format

Mauro Carvalho Chehab linux-doc lkml netdev rcu 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest10 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/10docs: RCU: convert checklist.txt to ReSTDocumentation/RCU/checklist.rst Documentation/RCU/index.rst+15 -50 replies
2/10docs: RCU: convert lockdep-splat.txt to ReSTDocumentation/RCU/index.rst Documentation/RCU/lockdep-splat.rst+53 -470 replies
3/10docs: RCU: convert lockdep.txt to ReSTDocumentation/RCU/index.rst Documentation/RCU/lockdep.rst+9 -40 replies
4/10docs: RCU: convert rculist_nulls.txt to ReSTDocumentation/RCU/index.rst Documentation/RCU/rculist_nulls.rst Documentation/RCU/rculist_nulls.txt +2 more+198 -1750 replies
5/10docs: RCU: convert torture.txt to ReSTDocumentation/RCU/index.rst Documentation/RCU/torture.rst Documentation/locking/locktorture.rst +2 more+68 -560 replies
6/10docs: RCU: convert rcuref.txt to ReSTDocumentation/RCU/index.rst Documentation/RCU/rcuref.rst+101 -930 replies
7/10docs: RCU: RTFP: fix bibtex entriesDocumentation/RCU/RTFP.txt+49 -494 replies
8/10docs: RCU: convert RTFP.txt to ReSTDocumentation/RCU/RTFP.bib Documentation/RCU/RTFP.rst Documentation/RCU/index.rst +1 more+603 -2210 replies
9/10docs: RCU: stallwarn.txt: convert it to ReSTDocumentation/RCU/index.rst Documentation/RCU/stallwarn.rst kernel/rcu/tree_stall.h+37 -230 replies
10/10docs: RCU: rculist_nulls.rst: don't duplicate chapter namesDocumentation/RCU/rculist_nulls.rst+6 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/10] Manually convert RCU text files to ReST format

This patch series convert RCU patches to ReST.

One interesting point to be noticed hereis that the RTFP.txt file contain a broken TeX bib file. I suspect that someone added some new articles directly there without trying to use LaTeX to check if the addition is valid. Or maybe it is just due to some version differences from the time such references were added.

During the RTFP.txt conversion, I fixed the bibtex problems in order for it to be properly parsed by LaTeX, and used the fixed file to produce a list of the actually used references inside the RTFP.txt file., manually adding them to the converted RTFP.rst.

As not all references were mentioned there, I opted to preserve the converted RTFP.bib, as it could be useful for someone doing any research around RCU.

The results of those changes (together with other changes from my pending doc patches) are available at:

https://www.infradead.org/~mchehab/kernel_docs/RCU/index.html

And the series is on my git tree:

https://git.linuxtv.org/mchehab/experimental.git/log/?h=rcu-docs

Mauro Carvalho Chehab (10):
docs: RCU: convert checklist.txt to ReST
docs: RCU: convert lockdep-splat.txt to ReST
docs: RCU: convert lockdep.txt to ReST
docs: RCU: convert rculist_nulls.txt to ReST
docs: RCU: convert torture.txt to ReST
docs: RCU: convert rcuref.txt to ReST
docs: RCU: RTFP: fix bibtex entries
docs: RCU: convert RTFP.txt to ReST
docs: RCU: stallwarn.txt: convert it to ReST
docs: RCU: rculist_nulls.rst: don't duplicate chapter names

 Documentation/RCU/{RTFP.txt => RTFP.bib}      | 323 ++--------
 Documentation/RCU/RTFP.rst                    | 593 ++++++++++++++++++
 .../RCU/{checklist.txt => checklist.rst}      |  17 +-
 Documentation/RCU/index.rst                   |  11 +
 .../{lockdep-splat.txt => lockdep-splat.rst}  |  99 +--
 .../RCU/{lockdep.txt => lockdep.rst}          |  12 +-
 Documentation/RCU/rcu.rst                     |   4 +-
 Documentation/RCU/rculist_nulls.rst           | 200 ++++++
 Documentation/RCU/rculist_nulls.txt           | 172 -----
 Documentation/RCU/{rcuref.txt => rcuref.rst}  | 193 +++---
 .../RCU/{stallwarn.txt => stallwarn.rst}      |  55 +-
 .../RCU/{torture.txt => torture.rst}          | 115 ++--
 Documentation/locking/locktorture.rst         |   2 +-
 MAINTAINERS                                   |   4 +-
 include/linux/rculist_nulls.h                 |   2 +-
 kernel/rcu/rcutorture.c                       |   2 +-
 kernel/rcu/tree_stall.h                       |   4 +-
 net/core/sock.c                               |   4 +-
 18 files changed, 1139 insertions(+), 673 deletions(-)
 rename Documentation/RCU/{RTFP.txt => RTFP.bib} (82%)
 create mode 100644 Documentation/RCU/RTFP.rst
 rename Documentation/RCU/{checklist.txt => checklist.rst} (98%)
 rename Documentation/RCU/{lockdep-splat.txt => lockdep-splat.rst} (54%)
 rename Documentation/RCU/{lockdep.txt => lockdep.rst} (96%)
 create mode 100644 Documentation/RCU/rculist_nulls.rst
 delete mode 100644 Documentation/RCU/rculist_nulls.txt
 rename Documentation/RCU/{rcuref.txt => rcuref.rst} (50%)
 rename Documentation/RCU/{stallwarn.txt => stallwarn.rst} (90%)
 rename Documentation/RCU/{torture.txt => torture.rst} (76%)
Signature · 1 line
2.25.2