rust-lang / rust-lang/rustc-perf
Document include/exclude filters properly
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 733
- Forks
- 189
- Avg merge
- 10h 52m
- Merged PRs (30d)
- 43
Description
We currently support include=... and exclude=... on the rust-timer build/queue invocations; documented here: https://perf.rust-lang.org/help.html.
However, that documentation wasn't updated when we adjusted those in https://github.com/rust-lang/rustc-perf/pull/1279.
We should (a) update the documentation and (b) consider adding support for the other CLI flags to be parsed. I personally think it's probably not worth the effort to support more flags; in practice these are rarely used and collecting a full suite isn't that much slower (given CI times etc) than a partial one. That could change with runtime benchmarks being added though.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the include/exclude documentation in help.html and compare it with the behavior adjusted in rustc-perf#1279. Update the documented rust-timer build/queue filters, and clarify whether parsing additional CLI flags is out of scope. Done means the documentation matches the supported flags and the scope decision is recorded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100