Skip to content
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

Documentation Improvements and Typo Fixes #3907

Closed
wants to merge 2 commits into from
Closed

Documentation Improvements and Typo Fixes #3907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be93978
Update README.md
Hopium21 Nov 21, 2024
d79285d
Update README.md
Hopium21 Nov 21, 2024
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ just careful

## Testing on CI

To test as if running on CI, one must limit the number of cores and ram to match github runners (2 core, 7 gig ram). To limit the ram, spin up a virtual machine or container with 7 gigs ram. To limit the core count when running tests:
To test as if running on CI, one must limit the number of cores and ram to match github runners (2 cores, 7GB ram). To limit the ram, spin up a virtual machine or container with 7 gigs ram. To limit the core count when running tests:

```
ASYNC_STD_THREAD_COUNT=1 RUST_LOG=$ERROR_LOG_LEVEL RUST_LOG_FORMAT=$ERROR_LOG_FORMAT just tokio test
Expand Down Expand Up @@ -177,7 +177,7 @@ heaptrack $(fd -I "counter*" -t x | rg release) --ignored -- test_stress_dht_man
# palette provides memory statistics, omission will provide cpu cycle stats as colors
# NOTE: must be run as root on macos
flamegraph --palette=mem $(fd -I "counter*" -t x | rg release) --ignored -- test_stress_dht_one_round
# code coveragte statistics
# code coverage statistics
cargo-llvm-cov llvm-cov --test=test_stress_dht_many_round --workspace --all-targets --release --html --output-path lcov.html
```

Expand Down
4 changes: 2 additions & 2 deletions crates/examples/push-cdn/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Steps
---------------

KeyDB is the ephemeral database, it's like Redis but with extra features. The only thing we run it with is with `--requirepass` to set a password.
KeyDB is the ephemeral database, it's like Redis but with extra features. The only thing we run it with `--requirepass` to set a password.

**Marshals:**
The marshal is the entry point of the push CDN, all users connect there first. It tells users which broker to connect to.
Expand Down Expand Up @@ -65,4 +65,4 @@ sleep 1m
just example_fixed_leader multi-validator-push-cdn -- 9 http://127.0.0.1:4444
```

Remember, you have to run leaders first, then other validators, so that leaders will have lower index.
Remember, you have to run leaders first, then other validators, so that leaders will have lower index.