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

meysam81 · 2023-08-19T15:10:52Z

fixes #114995

rustbot · 2023-08-19T15:10:59Z

r? @GuillaumeGomez

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

GuillaumeGomez · 2023-08-19T15:11:53Z

r? @epage

src/doc/rustc/src/profile-guided-optimization.md

epage · 2023-08-20T00:11:20Z

@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 · 2023-08-20T11:48:58Z

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 · 2023-09-12T02:46:28Z

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

meysam81 · 2023-09-12T02:49:21Z

@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 · 2023-10-21T12:56:12Z

@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 · 2023-10-23T08:22:32Z

src/doc/rustc/src/profile-guided-optimization.md

+```bash
+# Install the binary as usual: cargo install cargo-pgo
+cargo pgo build
+LLVM_PROFILE_FILE=./target/pgo-profiles/rustc-pgo_%m_%p.profraw ./target/x86_64-unknown-linux-gnu/release/myprogram


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.

src/doc/rustc/src/profile-guided-optimization.md

ehuss · 2023-10-23T18:04:36Z

r? ehuss

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

Co-authored-by: Jakub Beránek <berykubik@gmail.com>

meysam81 · 2023-10-25T01:46:07Z

@ehuss

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

ehuss · 2023-10-27T02:47:39Z

Thanks!

@bors r+ rollup

bors · 2023-10-27T02:47:41Z

📌 Commit 515535a has been approved by ehuss

It is now in the queue for this repository.

…-to-docs, r=ehuss feat(docs): add cargo-pgo to PGO documentation 📝 fixes rust-lang#114995

Rollup of 5 pull requests Successful merges: - rust-lang#114998 (feat(docs): add cargo-pgo to PGO documentation 📝) - rust-lang#116858 (Suggest assoc fn `new` when trying to build tuple struct with private fields) - rust-lang#116868 (Tweak suggestion span for outer attr and point at item following invalid inner attr) - rust-lang#117025 (Cleanup and improve `--check-cfg` implementation) - rust-lang#117240 (Fix documentation typo in std::iter::Iterator::collect_into) r? `@ghost` `@rustbot` modify labels: rollup

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#114998 (feat(docs): add cargo-pgo to PGO documentation 📝) - rust-lang#116868 (Tweak suggestion span for outer attr and point at item following invalid inner attr) - rust-lang#117240 (Fix documentation typo in std::iter::Iterator::collect_into) - rust-lang#117241 (Stash and cancel cycle errors for auto trait leakage in opaques) - rust-lang#117262 (Create a new ConstantKind variant (ZeroSized) for StableMIR) - rust-lang#117266 (replace transmute by raw pointer cast) r? `@ghost` `@rustbot` modify labels: rollup

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

Kobzol · 2023-10-27T12:52:07Z

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

ehuss · 2023-10-27T13:34:27Z

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 · 2023-10-27T13:35:29Z

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

rustbot assigned GuillaumeGomez Aug 19, 2023

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 19, 2023

rustbot assigned epage and unassigned GuillaumeGomez Aug 19, 2023

Kobzol reviewed Aug 19, 2023

View reviewed changes

src/doc/rustc/src/profile-guided-optimization.md Outdated Show resolved Hide resolved

src/doc/rustc/src/profile-guided-optimization.md Outdated Show resolved Hide resolved

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

15f0149

meysam81 force-pushed the meysam/feat/add-cargo-pgo-to-docs branch from 09e6af9 to 15f0149 Compare August 20, 2023 07:55

meysam81 requested a review from Kobzol October 23, 2023 05:51

Kobzol reviewed Oct 23, 2023

View reviewed changes

rustbot assigned ehuss and unassigned epage Oct 23, 2023

meysam81 and others added 3 commits October 25, 2023 08:43

Update src/doc/rustc/src/profile-guided-optimization.md

29ec0ec

Co-authored-by: Jakub Beránek <berykubik@gmail.com>

Update src/doc/rustc/src/profile-guided-optimization.md

3ecc8c3

Co-authored-by: Jakub Beránek <berykubik@gmail.com>

Update profile-guided-optimization.md

515535a

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 27, 2023

TaKO8Ki added a commit to TaKO8Ki/rust that referenced this pull request Oct 27, 2023

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

TaKO8Ki mentioned this pull request Oct 27, 2023

Rollup of 5 pull requests #117264

Closed

matthiaskrgr mentioned this pull request Oct 27, 2023

Rollup of 6 pull requests #117272

Merged

bors merged commit 8d67c32 into rust-lang:master Oct 27, 2023
11 checks passed

rustbot added this to the 1.75.0 milestone Oct 27, 2023

meysam81 deleted the meysam/feat/add-cargo-pgo-to-docs branch October 27, 2023 12:53

github-actions bot mentioned this pull request Oct 31, 2023

Automated pull from upstream master ferrocene/ferrocene#74

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

meysam81 commented Aug 19, 2023

rustbot commented Aug 19, 2023

GuillaumeGomez commented Aug 19, 2023

epage commented Aug 20, 2023

GuillaumeGomez commented Aug 20, 2023

zamazan4ik commented Sep 12, 2023

meysam81 commented Sep 12, 2023

zamazan4ik commented Oct 21, 2023

Kobzol left a comment

Kobzol Oct 23, 2023

ehuss commented Oct 23, 2023

meysam81 commented Oct 25, 2023

ehuss commented Oct 27, 2023

bors commented Oct 27, 2023

Kobzol commented Oct 27, 2023

ehuss commented Oct 27, 2023

Kobzol commented Oct 27, 2023

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

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

Conversation

meysam81 commented Aug 19, 2023

rustbot commented Aug 19, 2023

GuillaumeGomez commented Aug 19, 2023

epage commented Aug 20, 2023

GuillaumeGomez commented Aug 20, 2023

zamazan4ik commented Sep 12, 2023

meysam81 commented Sep 12, 2023

zamazan4ik commented Oct 21, 2023

Kobzol left a comment

Choose a reason for hiding this comment

Kobzol Oct 23, 2023

Choose a reason for hiding this comment

ehuss commented Oct 23, 2023

meysam81 commented Oct 25, 2023

ehuss commented Oct 27, 2023

bors commented Oct 27, 2023

Kobzol commented Oct 27, 2023

ehuss commented Oct 27, 2023

Kobzol commented Oct 27, 2023