summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Peter <mail@david-peter.de>2022-02-20 17:08:39 +0100
committerDavid Peter <mail@david-peter.de>2022-02-20 17:08:39 +0100
commit6365e3dc0c436b2442cda70802bd3b0f7e214eee (patch)
tree70c3d6091d9acd1eb76db485da2d9ce5eed6ae83
parent3c772009c468ad33a792246a977e90eb42d6c7bb (diff)
Update BenchmarkResult documentation
-rw-r--r--src/benchmark/benchmark_result.rs16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/benchmark/benchmark_result.rs b/src/benchmark/benchmark_result.rs
index 0e60d8f..26714c7 100644
--- a/src/benchmark/benchmark_result.rs
+++ b/src/benchmark/benchmark_result.rs
@@ -9,10 +9,10 @@ use crate::util::units::Second;
// `parameters` map. Update `src/hyperfine/export/csv.rs` with new fields, as appropriate.
#[derive(Debug, Default, Clone, Serialize, PartialEq)]
pub struct BenchmarkResult {
- /// The command that was run
+ /// The full command line of the program that is being benchmarked
pub command: String,
- /// The mean run time
+ /// The average run time
pub mean: Second,
/// The standard deviation of all run times. Not available if only one run has been performed
@@ -21,26 +21,26 @@ pub struct BenchmarkResult {
/// The median run time
pub median: Second,
- /// Time spend in user space
+ /// Time spent in user mode
pub user: Second,
- /// Time spent in system space
+ /// Time spent in kernel mode
pub system: Second,
- /// Min time measured
+ /// Minimum of all measured times
pub min: Second,
- /// Max time measured
+ /// Maximum of all measured times
pub max: Second,
/// All run time measurements
#[serde(skip_serializing_if = "Option::is_none")]
pub times: Option<Vec<Second>>,
- /// All run exit codes
+ /// Exit codes of all command invocations
pub exit_codes: Vec<Option<i32>>,
- /// Any parameter values used
+ /// Parameter values for this benchmark
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub parameters: BTreeMap<String, String>,
}