Skip to content

docs: add benchmarking to torrent repo README #886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
josecelano merged 1 commit into from
Jun 10, 2024
Merged

docs: add benchmarking to torrent repo README #886

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions packages/torrent-repository/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
# Torrust Tracker Configuration
# Torrust Tracker Torrent Repository

A library to provide torrent repository to the [Torrust Tracker](https://github.com/torrust/torrust-tracker).
A library to provide a torrent repository to the [Torrust Tracker](https://github.com/torrust/torrust-tracker).

## Benchmarking

```console
cargo bench -p torrust-tracker-torrent-repository
```

Example partial output:

```output
Running benches/repository_benchmark.rs (target/release/deps/repository_benchmark-a9b0013c8d09c3c3)
add_one_torrent/RwLockStd
time: [63.057 ns 63.242 ns 63.506 ns]
Found 12 outliers among 100 measurements (12.00%)
2 (2.00%) low severe
2 (2.00%) low mild
2 (2.00%) high mild
6 (6.00%) high severe
add_one_torrent/RwLockStdMutexStd
time: [62.505 ns 63.077 ns 63.817 ns]
```

## Documentation

Expand Down