Re: [PATCH RESEND 3/4] Documentation/litmus-tests: Merge atomic's README into top-level one

[Boqun Feng <boqun.feng@gmail.com>]

On Wed, May 13, 2020 at 06:39:03AM +0900, Akira Yokosawa wrote:
> From 96fa6680e3b990633ecbb6d11acf03a161b790bd Mon Sep 17 00:00:00 2001
> From: Akira Yokosawa <akiyks@gmail.com>
> Date: Sun, 10 May 2020 15:12:57 +0900
> Subject: [PATCH RESEND 3/4] Documentation/litmus-tests: Merge atomic's README into top-level one
> 
> Where Documentation/litmus-tests/README lists RCU litmus tests,
> Documentation/litmus-tests/atomic/README lists atomic litmus tests.
> For symmetry, merge the latter into former, with some context
> adjustment in the introduction.
> 
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Acked-by: Andrea Parri <parri.andrea@gmail.com>
> Acked-by: Joel Fernandes (Google) <joel@joelfernandes.org>

Acked-by: Boqun Feng <boqun.feng@gmail.com>

Thanks!

Regards,
Boqun

> ---
>  Documentation/litmus-tests/README        | 19 +++++++++++++++++++
>  Documentation/litmus-tests/atomic/README | 16 ----------------
>  2 files changed, 19 insertions(+), 16 deletions(-)
>  delete mode 100644 Documentation/litmus-tests/atomic/README
> 
> diff --git a/Documentation/litmus-tests/README b/Documentation/litmus-tests/README
> index c4307ea9f996..ac0b270b456c 100644
> --- a/Documentation/litmus-tests/README
> +++ b/Documentation/litmus-tests/README
> @@ -2,6 +2,25 @@
>  LITMUS TESTS
>  ============
>  
> +Each subdirectory contains litmus tests that are typical to describe the
> +semantics of respective kernel APIs.
> +For more information about how to "run" a litmus test or how to generate
> +a kernel test module based on a litmus test, please see
> +tools/memory-model/README.
> +
> +
> +atomic (/atomic derectory)
> +--------------------------
> +
> +Atomic-RMW+mb__after_atomic-is-stronger-than-acquire.litmus
> +    Test that an atomic RMW followed by a smp_mb__after_atomic() is
> +    stronger than a normal acquire: both the read and write parts of
> +    the RMW are ordered before the subsequential memory accesses.
> +
> +Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus
> +    Test that atomic_set() cannot break the atomicity of atomic RMWs.
> +
> +
>  RCU (/rcu directory)
>  --------------------
>  
> diff --git a/Documentation/litmus-tests/atomic/README b/Documentation/litmus-tests/atomic/README
> deleted file mode 100644
> index 714cf93816ea..000000000000
> --- a/Documentation/litmus-tests/atomic/README
> +++ /dev/null
> @@ -1,16 +0,0 @@
> -This directory contains litmus tests that are typical to describe the semantics
> -of our atomic APIs. For more information about how to "run" a litmus test or
> -how to generate a kernel test module based on a litmus test, please see
> -tools/memory-model/README.
> -
> -============
> -LITMUS TESTS
> -============
> -
> -Atomic-RMW+mb__after_atomic-is-stronger-than-acquire
> -	Test that an atomic RMW followed by a smp_mb__after_atomic() is
> -	stronger than a normal acquire: both the read and write parts of
> -	the RMW are ordered before the subsequential memory accesses.
> -
> -Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus
> -	Test that atomic_set() cannot break the atomicity of atomic RMWs.
> -- 
> 2.17.1
> 
>