Re: [PATCH RFC 0/5] rcu doc updates for whatisRCU and checklist

From: Paul E. McKenney
Date: Fri Oct 05 2018 - 20:13:59 EST


On Fri, Oct 05, 2018 at 04:18:09PM -0700, Joel Fernandes (Google) wrote:
> Hi Paul,
>
> Here are this week's rcu doc updates based on combing through whatisRCU and
> checklists. Hopefully you agree with them. I left several old _bh and _sched
> API references as is, since I don't think its a good idea to remove them till
> the APIs themselves are removed, however I did remove several of them as well
> (like in the first patch in this series) since I feel its better to "encourage"
> new users not to use the old API.
>
> Also do you think it makes sense for us to write coccinelle patches to check if
> folks use them on new patches? Btw, I am new to coccinelle but I'd love to give
> it a try, it looks exciting. I remember you saying you wanted to do that, so
> that's something else you could potentially offload to me as you see fit ;-)
>
> Thank you very much!

Good catches, applied and pushed, thank you!

I updated the commit log and a couple of the patches a bit, so could
you please double-check them?

Thanx, Paul

> Joel Fernandes (Google) (5):
> doc: rcu: Update core and full API in whatisRCU
> doc: rcu: Add more rationale for using rcu_read_lock_sched in
> checklist
> doc: rcu: Remove obsolete suggestion from checklist
> doc: rcu: Remove obsolete checklist item about synchronize_rcu usage
> doc: rcu: Encourage use of rcu_barrier in checklist
>
> Documentation/RCU/checklist.txt | 49 +++++++----------------------
> Documentation/RCU/whatisRCU.txt | 55 +++++++++++++++++----------------
> 2 files changed, 39 insertions(+), 65 deletions(-)
>
> --
> 2.19.0.605.g01d371f741-goog
>