doc, examples: revise docs and move examples

Cargo.toml

@@ -1,8 +1,15 @@
 [package]
 name = "kvbench"
 version = "0.1.0"
+authors = ["Chen Chen <mail@roychan.org>"]
+description = "A key-value store benchmark framework with customizable workloads"
 edition = "2021"
-exclude = ["presets", "examples"]
+readme = "README.md"
+repository = "https://www.github.com/nerdroychan/kvbench"
+license-file = "LICENSE"
+keywords = ["benchmark", "key-value"]
+categories = ["concurrency", "development-tools::profiling", "development-tools::testing"]
+exclude = ["examples"]
 
 [dependencies]
 ahash = "0.8.11"

README.md

@@ -3,7 +3,7 @@
 ![GitHub Workflow](https://github.com/nerdroychan/kvbench/actions/workflows/test.yml/badge.svg)
 ![GPLv3](https://img.shields.io/github/license/nerdroychan/kvbench)
 
-A benchmarking framework designed for testing key-value stores with easily customizable
+A benchmark framework designed for testing key-value stores with easily customizable
 workloads.
 
 ## Introduction
@@ -14,7 +14,7 @@ in TOML-formatted files. The built-in command line interface is capable of loadi
 running the benchmarks as specified.
 
 In addition to standard single-process benchmarks, it also seamlessly incorporates a key-value
-client/server setup that operates with a dedicated server thread or machine.
+client/server implementation that operates with a dedicated server thread or machine.
 
 ## Usage
 

examples/mixed/run.sh

@@ -5,7 +5,7 @@ DIR="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
 cargo build --profile release-lto
 
 STORE_DIR=$DIR/../../presets/stores
-BENCHMARK=$DIR/../../presets/benchmarks/mixed.toml
+BENCHMARK=$DIR/mixed.toml
 
 STORES="chashmap contrie dashmap flurry papaya scchashmap mutex_hashmap rwlock_hashmap"
 

examples/readpopular/run.sh

@@ -5,7 +5,7 @@ DIR="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
 cargo build --profile release-lto
 
 STORE_DIR=$DIR/../../presets/stores
-BENCHMARK=$DIR/../../presets/benchmarks/readpopular.toml
+BENCHMARK=$DIR/readpopular.toml
 
 STORES="chashmap contrie dashmap flurry papaya scchashmap mutex_hashmap rwlock_hashmap"
 

examples/writeheavy/run.sh

@@ -5,7 +5,7 @@ DIR="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
 cargo build --profile release-lto
 
 STORE_DIR=$DIR/../../presets/stores
-BENCHMARK=$DIR/../../presets/benchmarks/writeheavy.toml
+BENCHMARK=$DIR/writeheavy.toml
 
 STORES="chashmap contrie dashmap flurry papaya scchashmap mutex_hashmap rwlock_hashmap"
 

src/bench.rs

@@ -104,10 +104,10 @@ enum ReportMode {
 /// set for them.
 #[derive(Deserialize, Clone, Debug)]
 pub struct BenchmarkOpt {
-    /// Number of threads that runs this benchmark. Default 1.
+    /// Number of threads that runs this benchmark. Default: 1.
     pub threads: Option<usize>,
 
-    /// How many times this benchmark will be repeated. Default 1.
+    /// How many times this benchmark will be repeated. Default: 1.
     pub repeat: Option<usize>,
 
     /// How long this benchmark will run, unit is seconds. If this option is specified, the `ops`
@@ -130,13 +130,13 @@ pub struct BenchmarkOpt {
     /// - "all": equals to "repeat" + "finish".
     pub report: Option<String>,
 
-    /// Max depth of queue for each worker (async only).
+    /// Max depth of queue for each worker. Only useful with [`AsyncKVMap`]. Default: 1.
     ///
     /// When the pending requests are less than `qd`, the worker will not attempt to get more
     /// responses.
     pub qd: Option<usize>,
 
-    /// Batch size for each request (async only).
+    /// Batch size for each request Only useful with [`AsyncKVMap`]. Default: 1.
     pub batch: Option<usize>,
 
     /// The definition of a workload.

src/lib.rs

@@ -1,4 +1,4 @@
-//! A benchmarking framework designed for testing key-value stores with easily customizable
+//! A benchmark framework designed for testing key-value stores with easily customizable
 //! workloads.
 //!
 //! With `kvbench`, you can define the details of a benchmark using the TOML format, such as the
@@ -11,7 +11,7 @@
 //! trait, depending on the type of the store. After registering your store, simply reuse the
 //! exported [`cmdline()`] in your `main` function and it will work seamlessly with your own store.
 //!
-//! A few noteworthy design choices include:
+//! A few key design choices include:
 //!
 //! - Each key-value store exclusively stores a single type of key/value pair: variable-sized byte
 //! arrays represented as [`u8`] slices on the heap. No generics over the key's type.