Re: [Linux-kernel-mentees] [PATCH] Documentation: RCU: NMI-RCU: Converted NMI-RCU.txt to NMI-RCU.rst.

[Phong Tran]

On 11/5/19 8:55 PM, Paul E. McKenney wrote:
> On Tue, Nov 05, 2019 at 08:40:05PM +0700, Phong Tran wrote:
> > On 10/29/19 4:42 AM, madhuparnabhowmik04@xxxxxxxxx wrote:
> > > From: Madhuparna Bhowmik <madhuparnabhowmik04@xxxxxxxxx>
> > >
> > > This patch converts NMI-RCU from txt to rst format.
> > > Also adds NMI-RCU in the index.rst file.
> > >
> > > Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@xxxxxxxxx>
> > > -- >   .../RCU/{NMI-RCU.txt => NMI-RCU.rst}          | 53 ++++++++++---------
> > >    Documentation/RCU/index.rst                   |  1 +
> > >    2 files changed, 29 insertions(+), 25 deletions(-)
> > >    rename Documentation/RCU/{NMI-RCU.txt => NMI-RCU.rst} (73%)
> > >
> > > diff --git a/Documentation/RCU/NMI-RCU.txt b/Documentation/RCU/NMI-RCU.rst
> > > similarity index 73%
> > > rename from Documentation/RCU/NMI-RCU.txt
> > > rename to Documentation/RCU/NMI-RCU.rst
> > > index 881353fd5bff..da5861f6a433 100644
> > > --- a/Documentation/RCU/NMI-RCU.txt
> > > +++ b/Documentation/RCU/NMI-RCU.rst
> > > @@ -1,4 +1,7 @@
> > > +.. _NMI_rcu_doc:
> > > +
> > >    Using RCU to Protect Dynamic NMI Handlers
> > > +=========================================
> > >    Although RCU is usually used to protect read-mostly data structures,
> > > @@ -9,7 +12,7 @@ work in "arch/x86/oprofile/nmi_timer_int.c" and in
> > >    "arch/x86/kernel/traps.c".
> > >    The relevant pieces of code are listed below, each followed by a
> > > -brief explanation.
> > > +brief explanation.::
> > there is just a minor ":" redundant in html page.There are some same in this
> > patch.
> > eg:
> >   brief explanation.:
> >
> > Other things look good to me.
> >
> > Tested-by: Phong Tran <tranmanphong@xxxxxxxxx>
>
> Thank you, Phong!
>
> I queued a commit to be squashed into Madhuparna's original as shown below
> which adds your Tested-by and attempts a fix.  Does this work for you?

Yes, Paul.

Regards,
Phong.

> 							Thanx, Paul
>
> ------------------------------------------------------------------------
>
> commit 2c29f1c481f74f5e5aaaab195042f4df6a0b8119
> Author: Paul E. McKenney <paulmck@xxxxxxxxxx>
> Date:   Tue Nov 5 05:51:12 2019 -0800
>
>      squash! Documentation: RCU: NMI-RCU: Converted NMI-RCU.txt to NMI-RCU.rst.
>      
>      [ paulmck: Apply feedback from Phong Tran. ]
>      Tested-by: Phong Tran <tranmanphong@xxxxxxxxx>
>      Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxx>
>
> diff --git a/Documentation/RCU/NMI-RCU.rst b/Documentation/RCU/NMI-RCU.rst
> index da5861f..1809583 100644
> --- a/Documentation/RCU/NMI-RCU.rst
> +++ b/Documentation/RCU/NMI-RCU.rst
> @@ -12,7 +12,7 @@ work in "arch/x86/oprofile/nmi_timer_int.c" and in
>   "arch/x86/kernel/traps.c".
>   
>   The relevant pieces of code are listed below, each followed by a
> -brief explanation.::
> +brief explanation::
>   
>   	static int dummy_nmi_callback(struct pt_regs *regs, int cpu)
>   	{
> @@ -21,12 +21,12 @@ brief explanation.::
>   
>   The dummy_nmi_callback() function is a "dummy" NMI handler that does
>   nothing, but returns zero, thus saying that it did nothing, allowing
> -the NMI handler to take the default machine-specific action.::
> +the NMI handler to take the default machine-specific action::
>   
>   	static nmi_callback_t nmi_callback = dummy_nmi_callback;
>   
>   This nmi_callback variable is a global function pointer to the current
> -NMI handler.::
> +NMI handler::
>   
>   	void do_nmi(struct pt_regs * regs, long error_code)
>   	{
> @@ -61,7 +61,7 @@ Quick Quiz:
>   
>   :ref:`Answer to Quick Quiz <answer_quick_quiz_NMI>`
>   
> -Back to the discussion of NMI and RCU...::
> +Back to the discussion of NMI and RCU::
>   
>   	void set_nmi_callback(nmi_callback_t callback)
>   	{