[PATCH 2/2] MAINTAINERS: list file memory-barriers.txt within the LKMM entry

[PATCH 2/2] MAINTAINERS: list file memory-barriers.txt within the LKMM entry

[Andrea Parri]

Now that a formal specification of the LKMM has become available to
the developer, some concern about how to track changes to the model
on the level of the "high-level documentation" was raised.

A first "mitigation" to this issue, suggested by Will, is to assign
maintainership (and responsibility!!)  of such documentation (here,
memory-barriers.txt) to the maintainers of the LKMM themselves.

Suggested-by: Will Deacon <will.deacon@arm.com>
Signed-off-by: Andrea Parri <parri.andrea@gmail.com>
---
 On top of: https://marc.info/?l=linux-kernel&m=151748668632046&w=2 

 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index 08454be9237d7..9466907aa4db1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8106,6 +8106,7 @@ L:	linux-kernel@vger.kernel.org
 S:	Supported
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git
 F:	tools/memory-model/
+F:	Documentation/memory-barriers.txt
 
 LINUX SECURITY MODULE (LSM) FRAMEWORK
 M:	Chris Wright <chrisw@sous-sol.org>
-- 
2.7.4

Re: [PATCH 2/2] MAINTAINERS: list file memory-barriers.txt within the LKMM entry

[Paul E. McKenney]

On Fri, Feb 02, 2018 at 10:13:42AM +0100, Andrea Parri wrote:
> Now that a formal specification of the LKMM has become available to
> the developer, some concern about how to track changes to the model
> on the level of the "high-level documentation" was raised.
> 
> A first "mitigation" to this issue, suggested by Will, is to assign
> maintainership (and responsibility!!)  of such documentation (here,
> memory-barriers.txt) to the maintainers of the LKMM themselves.
> 
> Suggested-by: Will Deacon <will.deacon@arm.com>
> Signed-off-by: Andrea Parri <parri.andrea@gmail.com>

Very good, thank you, queued!  Please see below for the usual commit-log
rework.  BTW, in future submissions, could you please capitalize the
first word after the colon (":") in the subject line?  It is all too
easy for me to forget to change this, as Ingo can attest.  ;-)

If we are going to continue to use the LKMM acronym, should we make the
first line of the MAINTAINERS block look something like this?

	LINUX KERNEL MEMORY CONSISTENCY MODEL (LKMM)

One alternative would be to start calling it LKMCM, though that does
look a bit like a Roman numeral.  ;-)

							Thanx, Paul

------------------------------------------------------------------------

commit 2f80571625dc2d1977acdef79267ba1645b07c53
Author: Andrea Parri <parri.andrea@gmail.com>
Date:   Fri Feb 2 10:13:42 2018 +0100

    MAINTAINERS: List file memory-barriers.txt within the LKMM entry
    
    We now have a shiny new Linux-kernel memory model (LKMM) and the old
    tried-and-true Documentation/memory-barrier.txt.  It would be good to
    keep these automatically synchronized, but in the meantime we need at
    least let people know that they are related.  Will suggested adding the
    Documentation/memory-barrier.txt file to the LKMM maintainership list,
    thus making the LKMM maintainers responsible for both the old and the new.
    This commit follows Will's excellent suggestion.
    
    Suggested-by: Will Deacon <will.deacon@arm.com>
    Signed-off-by: Andrea Parri <parri.andrea@gmail.com>
    Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>

diff --git a/MAINTAINERS b/MAINTAINERS
index ba4dc08fbe95..e6ad9b44e8fb 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8101,6 +8101,7 @@ L:	linux-kernel@vger.kernel.org
 S:	Supported
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git
 F:	tools/memory-model/
+F:	Documentation/memory-barriers.txt
 
 LINUX SECURITY MODULE (LSM) FRAMEWORK
 M:	Chris Wright <chrisw@sous-sol.org>

Re: [PATCH 2/2] MAINTAINERS: list file memory-barriers.txt within the LKMM entry

[Andrea Parri]

On Fri, Feb 02, 2018 at 03:51:02PM -0800, Paul E. McKenney wrote:
> On Fri, Feb 02, 2018 at 10:13:42AM +0100, Andrea Parri wrote:
> > Now that a formal specification of the LKMM has become available to
> > the developer, some concern about how to track changes to the model
> > on the level of the "high-level documentation" was raised.
> > 
> > A first "mitigation" to this issue, suggested by Will, is to assign
> > maintainership (and responsibility!!)  of such documentation (here,
> > memory-barriers.txt) to the maintainers of the LKMM themselves.
> > 
> > Suggested-by: Will Deacon <will.deacon@arm.com>
> > Signed-off-by: Andrea Parri <parri.andrea@gmail.com>
> 
> Very good, thank you, queued!  Please see below for the usual commit-log
> rework.  BTW, in future submissions, could you please capitalize the
> first word after the colon (":") in the subject line?  It is all too
> easy for me to forget to change this, as Ingo can attest.  ;-)

Sorry, I'll do my best! ;-)


> 
> If we are going to continue to use the LKMM acronym, should we make the
> first line of the MAINTAINERS block look something like this?

I've no strong opinion about whether we should, but it makes sense to me.
(The acronym is currently defined (and heavily used) in explanation.txt.)

Thanks,
  Andrea


> 
> 	LINUX KERNEL MEMORY CONSISTENCY MODEL (LKMM)
> 
> One alternative would be to start calling it LKMCM, though that does
> look a bit like a Roman numeral.  ;-)
> 
> 							Thanx, Paul
> 
> ------------------------------------------------------------------------
> 
> commit 2f80571625dc2d1977acdef79267ba1645b07c53
> Author: Andrea Parri <parri.andrea@gmail.com>
> Date:   Fri Feb 2 10:13:42 2018 +0100
> 
>     MAINTAINERS: List file memory-barriers.txt within the LKMM entry
>     
>     We now have a shiny new Linux-kernel memory model (LKMM) and the old
>     tried-and-true Documentation/memory-barrier.txt.  It would be good to
>     keep these automatically synchronized, but in the meantime we need at
>     least let people know that they are related.  Will suggested adding the
>     Documentation/memory-barrier.txt file to the LKMM maintainership list,
>     thus making the LKMM maintainers responsible for both the old and the new.
>     This commit follows Will's excellent suggestion.
>     
>     Suggested-by: Will Deacon <will.deacon@arm.com>
>     Signed-off-by: Andrea Parri <parri.andrea@gmail.com>
>     Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index ba4dc08fbe95..e6ad9b44e8fb 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -8101,6 +8101,7 @@ L:	linux-kernel@vger.kernel.org
>  S:	Supported
>  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git
>  F:	tools/memory-model/
> +F:	Documentation/memory-barriers.txt
>  
>  LINUX SECURITY MODULE (LSM) FRAMEWORK
>  M:	Chris Wright <chrisw@sous-sol.org>
> 

Re: [PATCH 2/2] MAINTAINERS: list file memory-barriers.txt within the LKMM entry

[Paul E. McKenney]

On Sat, Feb 03, 2018 at 02:08:00AM +0100, Andrea Parri wrote:
> On Fri, Feb 02, 2018 at 03:51:02PM -0800, Paul E. McKenney wrote:
> > On Fri, Feb 02, 2018 at 10:13:42AM +0100, Andrea Parri wrote:
> > > Now that a formal specification of the LKMM has become available to
> > > the developer, some concern about how to track changes to the model
> > > on the level of the "high-level documentation" was raised.
> > > 
> > > A first "mitigation" to this issue, suggested by Will, is to assign
> > > maintainership (and responsibility!!)  of such documentation (here,
> > > memory-barriers.txt) to the maintainers of the LKMM themselves.
> > > 
> > > Suggested-by: Will Deacon <will.deacon@arm.com>
> > > Signed-off-by: Andrea Parri <parri.andrea@gmail.com>
> > 
> > Very good, thank you, queued!  Please see below for the usual commit-log
> > rework.  BTW, in future submissions, could you please capitalize the
> > first word after the colon (":") in the subject line?  It is all too
> > easy for me to forget to change this, as Ingo can attest.  ;-)
> 
> Sorry, I'll do my best! ;-)
> 
> 
> > 
> > If we are going to continue to use the LKMM acronym, should we make the
> > first line of the MAINTAINERS block look something like this?
> 
> I've no strong opinion about whether we should, but it makes sense to me.
> (The acronym is currently defined (and heavily used) in explanation.txt.)

I have added an experimental commit to this effect (see the "EXP" at
the beginning of the subject line).  If there are no objections, I will
squash it into 12a62a1d0703 ("MAINTAINERS: Add the Memory Consistency
Model subsystem").

							Thanx, Paul

> Thanks,
>   Andrea
> 
> 
> > 
> > 	LINUX KERNEL MEMORY CONSISTENCY MODEL (LKMM)
> > 
> > One alternative would be to start calling it LKMCM, though that does
> > look a bit like a Roman numeral.  ;-)
> > 
> > 							Thanx, Paul
> > 
> > ------------------------------------------------------------------------
> > 
> > commit 2f80571625dc2d1977acdef79267ba1645b07c53
> > Author: Andrea Parri <parri.andrea@gmail.com>
> > Date:   Fri Feb 2 10:13:42 2018 +0100
> > 
> >     MAINTAINERS: List file memory-barriers.txt within the LKMM entry
> >     
> >     We now have a shiny new Linux-kernel memory model (LKMM) and the old
> >     tried-and-true Documentation/memory-barrier.txt.  It would be good to
> >     keep these automatically synchronized, but in the meantime we need at
> >     least let people know that they are related.  Will suggested adding the
> >     Documentation/memory-barrier.txt file to the LKMM maintainership list,
> >     thus making the LKMM maintainers responsible for both the old and the new.
> >     This commit follows Will's excellent suggestion.
> >     
> >     Suggested-by: Will Deacon <will.deacon@arm.com>
> >     Signed-off-by: Andrea Parri <parri.andrea@gmail.com>
> >     Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
> > 
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index ba4dc08fbe95..e6ad9b44e8fb 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -8101,6 +8101,7 @@ L:	linux-kernel@vger.kernel.org
> >  S:	Supported
> >  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git
> >  F:	tools/memory-model/
> > +F:	Documentation/memory-barriers.txt
> >  
> >  LINUX SECURITY MODULE (LSM) FRAMEWORK
> >  M:	Chris Wright <chrisw@sous-sol.org>
> > 
>