diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/development.md b/docs/development.md index d7f6068..cb42492 100644 --- a/docs/development.md +++ b/docs/development.md @@ -17,6 +17,14 @@ needs at least one: a transport left out takes its tests and dependencies with i (`--features libp2p` builds neither `reqwest` and the daemon supervision of Mycelium, nor arti; among Mycelium's tests is a swarm simulated on its envelope). +The benchmarks are ignored tests named `bench_*`: the document's (writes and sync +messages, `document/bench.rs`), the remakes' replay (`remake/bench.rs`), and what +passing changes on costs over the simulated network (`simtest/bench.rs`: messages and +bytes per write by kind, propagation delays, for a full mesh, a writer behind NAT, two +transports and partial meshes of 50 and 100 nodes; about a quarter of an hour). One of +them alone: `cargo test --release --features mycelium,libp2p,tor,dashboard +bench_propagation -- --ignored --nocapture`. + The simulations send the wire encoding alone, as libp2p and Tor do; a simulated net can put messages into a transport's envelope instead (`SimNet::with_codec`), and every message kind is round-tripped through each codec (`wire::samples`). |