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

Jump to bottom

Add information about cargo-pgo to the Profile-Guided Optimization documentation #114995

Closed
zamazan4ik opened this issue Aug 19, 2023 · 3 comments · Fixed by #114998
Closed

Add information about cargo-pgo to the Profile-Guided Optimization documentation #114995

zamazan4ik opened this issue Aug 19, 2023 · 3 comments · Fixed by #114998
Assignees
@meysam81
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools

Comments

@zamazan4ik
Copy link
Contributor

zamazan4ik commented Aug 19, 2023 •
edited by rustbot
Loading

Location

https://doc.rust-lang.org/rustc/profile-guided-optimization.html

Summary

I think would be nice to mention cargo-pgo in the Rustc Profile-Guided Optimization documentation. With cargo-pgo it's much easier to apply PGO to the Rust programs (I did it many times). I suggest adding the information about cargo-pgo to the mentioned above page. Even if this project does not belong directly to Rustc or Cargo - it's still worth mentioning.

@Kobzol - ping you as the cargo-pgo author.

P.S. I am creating the issue here since not sure where it should go. Maybe we want to mention cargo-pgo in the Cargo book as well.
@zamazan4ik zamazan4ik added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Aug 19, 2023
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Aug 19, 2023
@meysam81
Copy link
Contributor

I don't know if this is already approved, but in case it is, here's my effort for a chance of contribution.

@meysam81
Copy link
Contributor

@rustbot claim

@meysam81 meysam81 mentioned this issue Aug 19, 2023
Merged
@Kobzol
Copy link
Contributor

Kobzol commented Aug 19, 2023

Well, I would of course like it to be mentioned in the docs :) I'm not sure what's the policy on linking to community maintained Cargo subcommands though (if there is any).

@Noratrieb Noratrieb removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Aug 22, 2023
TaKO8Ki added a commit to TaKO8Ki/rust that referenced this issue Oct 27, 2023
@TaKO8Ki
Rollup merge of rust-lang#114998 - meysam81:meysam/feat/add-cargo-pgo…
f3c94a5 
…-to-docs, r=ehuss

feat(docs): add cargo-pgo to PGO documentation 📝

fixes rust-lang#114995
@bors bors closed this as completed in 8d67c32 Oct 27, 2023
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Oct 27, 2023
@rust-timer
Unrolled build for rust-lang#114998
d3c2955 
Rollup merge of rust-lang#114998 - meysam81:meysam/feat/add-cargo-pgo-to-docs, r=ehuss

feat(docs): add cargo-pgo to PGO documentation 📝

fixes rust-lang#114995
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@meysam81 meysam81

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(docs): add cargo-pgo to PGO documentation 📝
5 participants
@Kobzol @zamazan4ik @meysam81 @rustbot @Noratrieb