On Tue, May 29, 2018 at 05:11:07AM -0700, Paul E. McKenney wrote: > On Tue, May 29, 2018 at 10:30:50AM +0100, Will Deacon wrote: > > Hi Paul, > > > > On Fri, May 25, 2018 at 12:10:20PM -0700, Paul E. McKenney wrote: > > > This commit documents the scheme used to generate the names for the > > > litmus tests. > > > > > > Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxxxxxxxxxx> > > > --- > > > README | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- > > > 1 file changed, 135 insertions(+), 1 deletion(-) > > > > Whilst I think documentation like this is extremely important for users, > > this feels like it's documenting how to drive parts of diy and I'm not > > convinced that it belongs in the kernel source tree as long as the projects > > remain separate. > > > > Why not contribute this to the herdtools7 documentation, then just reference > > that from here? That would also be helpful for other people interested in > > memory models, but perhaps not interested in Linux (assuming such people > > exist ;). > > We would still need at least a pointer from the Linux kernel to that > documentation, but I am happy either way. We probably need examples of > the common cases, but probably not a full exposition of all the available > herd7 edges. Completely agreed. > Should this be in the herdtools7 documentation, or as added detail > from a variation on the "diyone7 -bell linux-kernel.bell -show edges" > command? If the latter, I suppose that the ones coming from the .bell > file might simply be labelled as such. Many of the edges aren't specific to the Linux kernel, so I think they should be part of the diyone7 documentation. We could then describe only the additional edges added by the kernel memory model (e.g. "Once") in the kernel documentation. Will
