From 2e3e36c840e697830cd95207f77d6d84f6298fed Mon Sep 17 00:00:00 2001 From: "hinto.janai" Date: Wed, 9 Oct 2024 19:46:13 -0400 Subject: [PATCH] add to crates.md --- benches/benchmark/lib/README.md | 3 +-- books/architecture/src/appendix/crates.md | 8 ++++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/benches/benchmark/lib/README.md b/benches/benchmark/lib/README.md index 6abce6b0..9ea79ae4 100644 --- a/benches/benchmark/lib/README.md +++ b/benches/benchmark/lib/README.md @@ -3,8 +3,7 @@ This crate is the glue between [`cuprate-benchmark`](https://github.com/Cuprate/cuprate/tree/benches/benches/benchmark/bin) and all the benchmark crates. -It defines the [`cuprate_benchmark_lib::Benchmark`] trait, -which is the behavior of all benchmarks. +It defines the [`crate::Benchmark`] trait, which is the behavior of all benchmarks. See the [`cuprate-benchmark-example`](https://github.com/Cuprate/cuprate/tree/benches/benches/benchmark/example) crate to see an example implementation of this trait. diff --git a/books/architecture/src/appendix/crates.md b/books/architecture/src/appendix/crates.md index 1993c47e..c792250e 100644 --- a/books/architecture/src/appendix/crates.md +++ b/books/architecture/src/appendix/crates.md @@ -61,3 +61,11 @@ cargo doc --open --package cuprate-blockchain | [`cuprate-helper`](https://doc.cuprate.org/cuprate_helper) | [`helper/`](https://github.com/Cuprate/cuprate/tree/main/helper) | Kitchen-sink helper crate for Cuprate | [`cuprate-test-utils`](https://doc.cuprate.org/cuprate_test_utils) | [`test-utils/`](https://github.com/Cuprate/cuprate/tree/main/test-utils) | Testing utilities for Cuprate | [`cuprate-types`](https://doc.cuprate.org/cuprate_types) | [`types/`](https://github.com/Cuprate/cuprate/tree/main/types) | Shared types across Cuprate + +## Benchmarks +| Crate | In-tree path | Purpose | +|-------|--------------|---------| +| [`cuprate-benchmark`](https://doc.cuprate.org/cuprate_benchmark) | [`benches/benchmark/bin/`](https://github.com/Cuprate/cuprate/tree/main/benches/benchmark/bin) | Cuprate benchmarking binary +| [`cuprate-benchmark-lib`](https://doc.cuprate.org/cuprate_benchmark_lib) | [`benches/benchmark/lib/`](https://github.com/Cuprate/cuprate/tree/main/benches/benchmark/lib) | Cuprate benchmarking library +| `cuprate-benchmark-*` | [`benches/benchmark/cuprate-*`](https://github.com/Cuprate/cuprate/tree/main/benches/benchmark/) | Benchmark for a Cuprate crate that uses `cuprate-benchmark` +| `cuprate-criterion-*` | [`benches/criterion/cuprate-*`](https://github.com/Cuprate/cuprate/tree/main/benches/criterion) | Benchmark for a Cuprate crate that uses [Criterion](https://bheisler.github.io/criterion.rs/book) \ No newline at end of file