Skip to content

Commit ccc9971

Browse files
mchehabpaulmckrcu
mchehab
authored and
paulmckrcu
committed
docs: rcu: convert some articles from html to ReST
There are 4 RCU articles that are written on html format. The way they are, they can't be part of the Linux Kernel documentation body nor share the styles and pdf output. So, convert them to ReST format. This way, make htmldocs and make pdfdocs will produce a documentation output that will be like the original ones, but will be part of the Linux Kernel documentation body. Part of the conversion was done with the help of pandoc, but the result had some broken things that had to be manually fixed. Following are manual changes Mauro made when doing the automatic conversion: Quoting from: https://lore.kernel.org/rcu/[email protected]/ > > At least the pandoc's version I used here has a bug: its conversion > > from html to ReST on those files only start after a <body> tag - or > > when the first quiz table starts. I only discovered that adding a > > <body> at the beginning of the file solve this book at the last > > conversions. > > > > So, for most html->ReST conversions, I manually converted the first > > part of the document, basically stripping html paragraph tags and > > by replacing highlights by the ReST syntax. > > > > Also, all the quiz tables seem to assume some javascript macro or > > css style that would be hiding the answer part until the mouse moves > > to it. Such macro/css was not there at the kernel tree. So, the quiz > > answers have the same color as the background, making them invisible. > > Even if we had such macro/css, this is not portable for pdf/LaTeX output > > (and I'm not sure if this would work with ePub). > > > > So, I ended by manually doing the table conversion. > > > > Finally, I double-checked if the conversions ended ok, addressing any > > issues that might have heppened. > > > > So, after both automatic conversion and manual fixes, I opened both the > > html files produced by Sphinx and the original ones and compared them > > line per line (except for the indexes, as Sphinx produces them > > automatically), in order to see if all information from the original > > files will be there on a format close to what we have on other ReST > > files, fixing any pending issues if any. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent c07e6f3 commit ccc9971

File tree

11 files changed

+4978
-6104
lines changed

11 files changed

+4978
-6104
lines changed

‎Documentation/RCU/Design/Data-Structures/Data-Structures.html

Lines changed: 0 additions & 1391 deletions
This file was deleted.

‎Documentation/RCU/Design/Data-Structures/Data-Structures.rst

Lines changed: 1163 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/RCU/Design/Expedited-Grace-Periods/Expedited-Grace-Periods.html

Lines changed: 0 additions & 668 deletions
This file was deleted.

‎Documentation/RCU/Design/Expedited-Grace-Periods/Expedited-Grace-Periods.rst

Lines changed: 521 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Diagram.html

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.html

Lines changed: 0 additions & 704 deletions
This file was deleted.

‎Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.rst

Lines changed: 625 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)