Skip to contentSkip to conversation

MAINTAINERS: list file memory-barriers.txt within the LKMM entry

PATCH In review Andrea Parri 2 participants 4 messages Feb 2, 2018 – Feb 4, 2018

lore
Share & tools
lore
#0 lore raw

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

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.

---
On top of: https://marc.info/?l=linux-kernel&m=151748668632046&w=2

 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)
MAINTAINERS +1 -0
index 08454be9237d7..9466907aa4db1 100644
@@ -8106,6 +8106,7 @@ L:	[email protected]
 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 <[email protected]>
Signature · 1 line
2.7.4
#1 lore raw
Quoted 10 lines · 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.

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 <[email protected]>
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.

MAINTAINERS +1 -0
index ba4dc08fbe95..e6ad9b44e8fb 100644
@@ -8101,6 +8101,7 @@ L:	[email protected]
 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 <[email protected]>
#2 lore raw
Quoted 9 lines · Paul E. McKenney
Quoted 8 lines · 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.

Quoted 7 lines
Quoted 2 lines

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! ;-)

Quoted 3 lines

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

Quoted 41 lines

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 <[email protected]>
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.

MAINTAINERS +1 -0
index ba4dc08fbe95..e6ad9b44e8fb 100644
@@ -8101,6 +8101,7 @@ L:	[email protected]
 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 <[email protected]>
#3 lore raw
Quoted 22 lines · Andrea Parri
Quoted 9 lines · Paul E. McKenney
Quoted 8 lines · 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.

Quoted 7 lines
Quoted 2 lines

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! ;-)

Quoted 1 line
Quoted 5 lines
Quoted 2 lines

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

Quoted 46 lines

Thanks,
Andrea

Quoted 41 lines

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 <[email protected]>
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.

MAINTAINERS +1 -0
index ba4dc08fbe95..e6ad9b44e8fb 100644
@@ -8101,6 +8101,7 @@ L:	[email protected]
 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 <[email protected]>