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

[meysam81]

fixes #114995

[rustbot]

r? @GuillaumeGomez

(rustbot has picked a reviewer for you, use r? to override)

[GuillaumeGomez]

r? @epage

[epage]

@GuillaumeGomez wanted to check in for what you are looking for from me for reviewing this. cargo pgo is a third party subcommand that I don't even remember if I've heard of before.

[GuillaumeGomez]

I have no knowledge about this so set you as reviewer since I know you're in the cargo team and might know more or at least know who to put as reviewer?

[zamazan4ik]

@meysam81 @epage Could you please clarify the status of the PR?

[meysam81]

@zamazan4ik
The only concern so far has been whether a backref to community works violates any kind of standard in Rust docs, and perhaps a confirmation/approval of one of the members can benefit in proceeding with this PR. Other than that, we're good to go from my side.

[zamazan4ik]

@meysam81 @epage Sorry for the ping but seems like the PR stuck a little. According to the last comment, we need some kind of approval from a Rust dev team member. Do we need to ping someone else to this PR to continue work on it? Because cargo-pgo project is way too helpful for doing PGO across the Rust ecosystem, I want to improve the visibility of such a tool for the Rust community.

[Kobzol]

I sent a few comments, but as I've said before, I have a conflict of interest here 😆 To move the discussion forward, I'll ask on Zulip if it's ok to include community tools in the official documentation.

[Kobzol]

I would perhaps remove the LLVM_PROFILE_FILE env. var. It's only needed for programs that generate a lot of processes internally (which is not that common), so I think that it could be avoided in this example, to make it simpler.

[ehuss]

r? ehuss

Reassigning to myself since I am a maintainer/reviewer for these docs.

[meysam81]

@ehuss

The comments are applied as requested. Please let me know whether we can move forward with this PR, if at all!

[ehuss]

Thanks!

@bors r+ rollup

[bors]

📌 Commit 515535a has been approved by ehuss

It is now in the queue for this repository.

[Kobzol]

I wonder when/how is the actual website updated/deployed from the source (?).

[ehuss]

When the nightly release is made, the website at https://doc.rust-lang.org/nightly/ is updated.
Similarly, when a beta release is made, https://doc.rust-lang.org/beta/ is updated.
When a stable release is made, the version-specific site is updated, like https://doc.rust-lang.org/1.73.0/, and the aliases at https://doc.rust-lang.org/stable/ and the root https://doc.rust-lang.org/.

[Kobzol]

Oh, so it follows the compiler, that makes sense. Thanks!