linux-kernel - Re: [PATCH 00/10] Manually convert RCU text files to ReST format

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 21 Apr 2020 10:58:19 -0700
From:   "Paul E. McKenney" <paulmck@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>,
        Josh Triplett <josh@...htriplett.org>,
        Vito Caputo <vcaputo@...garu.com>,
        Alexey Dobriyan <adobriyan@...il.com>,
        Jakub Kicinski <kuba@...nel.org>,
        Davidlohr Bueso <dave@...olabs.net>,
        Joe Stringer <joe@...d.net.nz>,
        Joel Fernandes <joel@...lfernandes.org>,
        Martin KaFai Lau <kafai@...com>,
        Lai Jiangshan <jiangshanlai@...il.com>,
        Thomas Gleixner <tglx@...utronix.de>,
        Daniel Borkmann <daniel@...earbox.net>,
        Eric Dumazet <edumazet@...gle.com>,
        Peter Zijlstra <peterz@...radead.org>,
        Jakub Sitnicki <jakub@...udflare.com>, rcu@...r.kernel.org,
        Ingo Molnar <mingo@...hat.com>,
        zhanglin <zhang.lin16@....com.cn>, netdev@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Will Deacon <will@...nel.org>,
        Steven Rostedt <rostedt@...dmis.org>,
        Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
        Rob Herring <robh@...nel.org>
Subject: Re: [PATCH 00/10] Manually convert RCU text files to ReST format

On Tue, Apr 21, 2020 at 07:04:01PM +0200, Mauro Carvalho Chehab wrote:
> 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

I queued all but 7/10 and 8/10, for which I have the bibtex-to-ReST
conversion question.  Thank you for dragging these files kicking and
screaming into the year 2020!  ;-)

							Thanx, Paul

> 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%)
> 
> -- 
> 2.25.2
> 
>