Fix: revise obsolete command in README.md

Message ID 20220802174400.219630-1-ccs100203@gmail.com
State New
Headers
Series Fix: revise obsolete command in README.md |

Commit Message

Shao-Tse Hung Aug. 2, 2022, 5:44 p.m. UTC
  The obsolete command `make bench` was replaced by `make short_bench` and `make long_bench` in 2015.
However, this command wasn't revised in README, so I follow the previous commit and rewrite it.

Signed-off-by: Shao-Tse Hung <ccs100203 at gmail.com>
---
 README.md | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
  

Comments

Mathieu Desnoyers Aug. 2, 2022, 8:05 p.m. UTC | #1
----- On Aug 2, 2022, at 1:44 PM, Shao-Tse Hung via lttng-dev lttng-dev at lists.lttng.org wrote:

> The obsolete command `make bench` was replaced by `make short_bench` and `make
> long_bench` in 2015.
> However, this command wasn't revised in README, so I follow the previous commit
> and rewrite it.

Merged into liburcu master, 0.13, 0.12 branches, thanks!

Mathieu

> 
> Signed-off-by: Shao-Tse Hung <ccs100203 at gmail.com>
> ---
> README.md | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/README.md b/README.md
> index a8318c8..1e75589 100644
> --- a/README.md
> +++ b/README.md
> @@ -426,14 +426,15 @@ Make targets
> ------------
> 
> In addition to the usual `make check` target, Userspace RCU features
> -`make regtest` and `make bench` targets:
> +`make regtest`, `make short_bench` and `make long_bench` targets:
> 
>   - `make check`: short tests, meant to be run when rebuilding or
>     porting Userspace RCU.
>   - `make regtest`: long (many hours) test, meant to be run when
>     modifying Userspace RCU or porting it to a new architecture or
>     operating system.
> -  - `make bench`: long (many hours) benchmarks.
> +  - `make short_bench`: short benchmarks, 3 seconds per test.
> +  - `make long_bench`: long (many hours) benchmarks, 30 seconds per test.
> 
> 
> Known issues
> --
> 2.25.1
> 
> _______________________________________________
> lttng-dev mailing list
> lttng-dev at lists.lttng.org
> https://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
  

Patch

diff --git a/README.md b/README.md
index a8318c8..1e75589 100644
--- a/README.md
+++ b/README.md
@@ -426,14 +426,15 @@  Make targets
 ------------
 
 In addition to the usual `make check` target, Userspace RCU features
-`make regtest` and `make bench` targets:
+`make regtest`, `make short_bench` and `make long_bench` targets:
 
   - `make check`: short tests, meant to be run when rebuilding or
     porting Userspace RCU.
   - `make regtest`: long (many hours) test, meant to be run when
     modifying Userspace RCU or porting it to a new architecture or
     operating system.
-  - `make bench`: long (many hours) benchmarks.
+  - `make short_bench`: short benchmarks, 3 seconds per test.
+  - `make long_bench`: long (many hours) benchmarks, 30 seconds per test.
 
 
 Known issues