mirror of https://github.com/bevyengine/bevy synced 2024-11-25 22:20:20 +00:00

History

Zachary Harrold d70595b667 Add `core` and `alloc` over `std` Lints (#15281 ) # Objective - Fixes #6370 - Closes #6581 ## Solution - Added the following lints to the workspace: - `std_instead_of_core` - `std_instead_of_alloc` - `alloc_instead_of_core` - Used `cargo +nightly fmt` with [item level use formatting](https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=#Item%5C%3A) to split all `use` statements into single items. - Used `cargo clippy --workspace --all-targets --all-features --fix --allow-dirty` to _attempt_ to resolve the new linting issues, and intervened where the lint was unable to resolve the issue automatically (usually due to needing an `extern crate alloc;` statement in a crate root). - Manually removed certain uses of `std` where negative feature gating prevented `--all-features` from finding the offending uses. - Used `cargo +nightly fmt` with [crate level use formatting](https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=#Crate%5C%3A) to re-merge all `use` statements matching Bevy's previous styling. - Manually fixed cases where the `fmt` tool could not re-merge `use` statements due to conditional compilation attributes. ## Testing - Ran CI locally ## Migration Guide The MSRV is now 1.81. Please update to this version or higher. ## Notes - This is a _massive_ change to try and push through, which is why I've outlined the semi-automatic steps I used to create this PR, in case this fails and someone else tries again in the future. - Making this change has no impact on user code, but does mean Bevy contributors will be warned to use `core` and `alloc` instead of `std` where possible. - This lint is a critical first step towards investigating `no_std` options for Bevy. --------- Co-authored-by: François Mockers <francois.mockers@vleue.com>		2024-09-27 00:59:59 +00:00
..
benches	Add `core` and `alloc` over `std` Lints (#15281 )	2024-09-27 00:59:59 +00:00
Cargo.toml	Update ``glam` `to 0.29,` `encase`` to 0.10. (#15249 )	2024-09-23 19:44:02 +00:00
README.md	Add README to benches (#11508 )	2024-01-24 17:11:28 +00:00

README.md

Bevy Benchmarks

This is a crate with a collection of benchmarks for Bevy, separate from the rest of the Bevy crates.

Running the benchmarks

Setup everything you need for Bevy with the setup guide.
Move into the benches directory (where this README is located).
```
bevy $ cd benches
```
Run the benchmarks with cargo (This will take a while)
```
bevy/benches $ cargo bench
```
If you'd like to only compile the benchmarks (without running them), you can do that like this:
```
bevy/benches $ cargo bench --no-run
```

Criterion

Bevy's benchmarks use Criterion. If you want to learn more about using Criterion for comparing performance against a baseline or generating detailed reports, you can read the Criterion.rs documentation.