perf: Fixup ordering, fix pathing, docs (#38970)

Release Notes: - N/A

Nia committed 1 year ago

Commit 30b49cf1 parent c69912c6 files · +35 −20Browse files

Showing the changes to docs/src (1 of 6 files). Show all

Unified · Split

docs/src/development.md+6−0

@@ -79,6 +79,12 @@ Here's a typical workflow for comparing frame rendering performance between diff · 78 unmodified lines
79	79
80	80	The `script/histogram` tool can accept as many measurement files as you like and will generate a histogram visualization comparing the frame rendering performance data between the provided versions.
81	81
	82	+### Using `util_macros::perf`
	83	+
	84	+For benchmarking unit tests, annotate them with the `#[perf]` attribute from the `util_macros` crate. Then run `cargo
	85	+perf-test -p $CRATE` to benchmark them. See the rustdoc documentation on `crates/util_macros` and `tooling/perf` for
	86	+in-depth examples and explanations.
	87	+
82	88	## Contributor links
83	89
84	90	- [CONTRIBUTING.md](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md)