Merge pull request yegor256#271 from owtotwo/master

add some usage notes for benchmark file header

Author: yegor256

README.md

@@ -113,7 +113,7 @@ run `cargo fmt` and `cargo clippy`.
 Also, before you start making changes, run benchmarks:
 
 ```bash
-rustup run nightly cargo bench
+cargo bench --bench bench
 ```
 
 Then, after the changes you make, run it again. Compare the results.

benches/bench.rs

@@ -2,6 +2,28 @@
 // SPDX-FileCopyrightText: Copyright (c) 2025 owtotwo
 // SPDX-License-Identifier: MIT
 
+/// Benchmark Usage:
+///
+/// `cargo bench --bench bench` will run all benchmarks in this file.
+/// ("--bench bench" for this file named "bench.rs", without this, the
+/// command `cargo bench` will run all benchmarks in the project.)
+///
+/// If you want to run a single benchmark, you can use the command
+/// `cargo bench -- insert_same`.
+///
+/// To filter benchmarks, use `cargo bench -- <filter>`, where <filter> is
+/// a regular expression matching the benchmark ID.
+///
+/// For example, running `cargo bench -- length` would only run benchmarks
+/// whose ID contains the string "length", such as "straight_length" and
+/// "fragmented_length".
+///
+/// You can use `cargo bench -- length --list` to see what benchmarks will
+/// be run.
+///
+/// While `cargo bench -- insert_.+` would match start with "insert_", such
+/// as "insert_same", "insert_same_ignore_return", "insert_and_remove" and
+/// so on.
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
 use micromap::Map;
 
@@ -15,6 +37,15 @@ pub fn insert_benchmark(c: &mut Criterion) {
         });
     });
 
+    c.bench_function("insert_same_ignore_return", |b| {
+        let mut m: Map<u64, u64, 64> = Map::new();
+        b.iter(|| {
+            for i in 0..1000 {
+                let _ = m.insert(8, i);
+            }
+        });
+    });
+
     c.bench_function("insert_different", |b| {
         const CAP: usize = 64;
         let mut m: Map<usize, u64, CAP> = Map::new();
@@ -25,7 +56,29 @@ pub fn insert_benchmark(c: &mut Criterion) {
         });
     });
 
+    c.bench_function("insert_different_ignore_return", |b| {
+        const CAP: usize = 64;
+        let mut m: Map<usize, u64, CAP> = Map::new();
+        b.iter(|| {
+            for i in 0..CAP {
+                let _ = m.insert(i, 256);
+            }
+        });
+    });
+
     c.bench_function("insert_and_remove", |b| {
+        const CAP: usize = 64;
+        let mut m: Map<usize, u64, CAP> = Map::new();
+        b.iter(|| {
+            for i in 0..CAP {
+                let _ = m.insert(i, 256);
+                let _ = m.remove(&i);
+                black_box(m.len());
+            }
+        });
+    });
+
+    c.bench_function("insert_and_remove_ignore_return", |b| {
         const CAP: usize = 64;
         let mut m: Map<usize, u64, CAP> = Map::new();
         b.iter(|| {
@@ -134,6 +187,6 @@ criterion_group!(
     benches,
     insert_benchmark,
     length_benchmark,
-    // insert_exist_kv_in_diff_slot
+    // insert_exist_kv_in_diff_slot // ignored for now
 );
 criterion_main!(benches);