Re: [PATCH RFC tools/lkmm 09/12] tools/memory-model: Add required herd7 version to README file

From: Alan Stern
Date: Wed Feb 21 2018 - 11:51:41 EST


On Wed, 21 Feb 2018, Paul E. McKenney wrote:

> On Wed, Feb 21, 2018 at 10:10:52AM -0500, Alan Stern wrote:
> > On Tue, 20 Feb 2018, Paul E. McKenney wrote:
> >
> > > LKMM and the herd7 tool are co-evolving, and out-of-date herd7 tools
> > > produce inaccurate results, often with no obvious error messages. This
> > > commit therefore adds the required herd7 version to the LKMM README file.
> > >
> > > Longer term, it would be good if .cat files could specify the required
> > > version in a manner allowing herd7 to produce clear diagnostics.
> > >
> > > Suggested-by: Akira Yokosawa <akiyks@xxxxxxxxx>
> > > Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxxxxxxxxxx>
> > > ---
> > > tools/memory-model/README | 3 ++-
> > > 1 file changed, 2 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/tools/memory-model/README b/tools/memory-model/README
> > > index 91414a49fac5..ea950c566ffd 100644
> > > --- a/tools/memory-model/README
> > > +++ b/tools/memory-model/README
> > > @@ -20,7 +20,8 @@ that litmus test to be exercised within the Linux kernel.
> > > REQUIREMENTS
> > > ============
> > >
> > > -The "herd7" and "klitmus7" tools must be downloaded separately:
> > > +Version 7.48 of the "herd7" and "klitmus7" tools must be downloaded
> > > +separately:
> > >
> > > https://github.com/herd/herdtools7
> >
> > The text immediately below this mentions the Docker image and gentoo
> > package. Aren't they both seriously out of date at this point? In
> > which case, shouldn't we remove them from the README?
>
> Agreed, we should. How about the following?
>
> Thanx, Paul
>
> ------------------------------------------------------------------------
>
> commit b59fd89b465f0bfbfe06bf47e22c0cf160aef66b
> Author: Paul E. McKenney <paulmck@xxxxxxxxxxxxxxxxxx>
> Date: Wed Feb 21 08:13:48 2018 -0800
>
> tools/memory-model: Remove mention of docker/gentoo image
>
> Because the docker and gentoo images haven't been updated in quite some
> time, they are likely to provide more confusion than help. This commit
> therefore removes mention of them from the README file.
>
> Reported-by: Alan Stern <stern@xxxxxxxxxxxxxxxxxxx>
> Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxxxxxxxxxx>
>
> diff --git a/tools/memory-model/README b/tools/memory-model/README
> index ea950c566ffd..0b3a5f3c9ccd 100644
> --- a/tools/memory-model/README
> +++ b/tools/memory-model/README
> @@ -27,21 +27,6 @@ separately:
>
> See "herdtools7/INSTALL.md" for installation instructions.
>
> -Alternatively, Abhishek Bhardwaj has kindly provided a Docker image
> -of these tools at "abhishek40/memory-model". Abhishek suggests the
> -following commands to install and use this image:
> -
> - - Users should install Docker for their distribution.
> - - docker run -itd abhishek40/memory-model
> - - docker attach <id-emitted-from-the-previous-command>
> -
> -Gentoo users might wish to make use of Patrick McLean's package:
> -
> - https://gitweb.gentoo.org/repo/gentoo.git/tree/dev-util/herdtools7
> -
> -These packages may not be up-to-date with respect to the GitHub
> -repository.
> -
>
> ==================
> BASIC USAGE: HERD7

Yeah, that's good.

Alan