[Linux-kernel-mentees] [PATCH] doc: Convert to checklist.txt to checklist.rst

Amol Grover frextrite at gmail.com
Thu Feb 27 08:30:10 UTC 2020


On Wed, Feb 26, 2020 at 12:09:16AM +0530, amanharitsh123 wrote:
> This patch converts checklist.txt to checklist.rst and
> adds it to index.rst
> 

Hi Aman,

Thank you for the patch! But before this can be accepted there are a few
things that you need to take care of.

> Signed-off-by: amanharitsh123 <amanharitsh123 at gmail.com>

1. Signed-off-by *must* *always* include your full real name. You can
modify .gitconfig, or run `git config user.name "Your Name"` to change
this.

> ---
>  Documentation/RCU/{checklist.txt => checklist.rst} | 8 +++++---
>  Documentation/RCU/index.rst                        | 1 +
>  2 files changed, 6 insertions(+), 3 deletions(-)
>  rename Documentation/RCU/{checklist.txt => checklist.rst} (99%)
> 
> diff --git a/Documentation/RCU/checklist.txt b/Documentation/RCU/checklist.rst
> similarity index 99%
> rename from Documentation/RCU/checklist.txt
> rename to Documentation/RCU/checklist.rst
> index e98ff261a438..49bf7862c950 100644
> --- a/Documentation/RCU/checklist.txt
> +++ b/Documentation/RCU/checklist.rst
> @@ -1,5 +1,7 @@
> -Review Checklist for RCU Patches
> +.. checklist doc:

2. The document identifier must always start with an underscore and
should not contain white spaces, something like:
.. _checklist_doc:
should work.

>  
> +Review Checklist for RCU Patches
> +================================
>  
>  This document contains a checklist for producing and reviewing patches
>  that make use of RCU.  Violating any of the rules listed below will
> @@ -442,8 +444,8 @@ over a rather long period of time, but improvements are always welcome!
>  
>  	You instead need to use one of the barrier functions:
>  
> -	o	call_rcu() -> rcu_barrier()
> -	o	call_srcu() -> srcu_barrier()
> +	-	call_rcu() -> rcu_barrier()
> +	-	call_srcu() -> srcu_barrier()
>  
>  	However, these barrier functions are absolutely -not- guaranteed
>  	to wait for a grace period.  In fact, if there are no call_rcu()
> diff --git a/Documentation/RCU/index.rst b/Documentation/RCU/index.rst
> index 81a0a1e5f767..d60eb4ba2cd0 100644
> --- a/Documentation/RCU/index.rst
> +++ b/Documentation/RCU/index.rst
> @@ -10,6 +10,7 @@ RCU concepts
>     arrayRCU
>     rcubarrier
>     rcu_dereference
> +   checklist
>     whatisRCU
>     rcu
>     listRCU

3. The subject line needs a bit of tweaking.

Apart from the above mentioned changes, everything looks good!

Thanks
Amol

> -- 
> 2.20.1
> 
> _______________________________________________
> Linux-kernel-mentees mailing list
> Linux-kernel-mentees at lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees


More information about the Linux-kernel-mentees mailing list