Skip to content

Fix profile directory in crate graph self-profiling example #528

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.

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

Merged
merged 1 commit into from
Mar 1, 2020
Merged

Fix profile directory in crate graph self-profiling example #528

merged 1 commit into from
Mar 1, 2020

Conversation

HadrienG2
Copy link
Contributor

In the rustc self-profiling blog post, the proposed crate graph-wide self-profiling command is incorrect.

$ RUSTFLAGS="-Zself-profile=./profiles -Zself-profile-events=default,args" cargo build

The problem is that the ./profiles relative directory will be resolved with respect to whatever directory rustc happens to be working in at the time where the RUSTFLAGS are parsed. Which, for dependency crates, will be the source directory of those dependencies, not the source directory of the crate that we are working on.

Forcing directory resolution to be relative to the active crate's directory by replacing the rustc-evaluated . with a shell-evaluated $(pwd) resolves this problem.

Kudos to @bjorn3 for figuring this out!

In the rustc self-profiling blog post, the proposed crate graph-wide self-profiling command is incorrect.

```sh
$ RUSTFLAGS="-Zself-profile=./profiles -Zself-profile-events=default,args" cargo build
```

The problem is that the `./profiles` relative directory will be resolved with respect to whatever directory rustc happens to be working in at the time where the RUSTFLAGS are parsed. Which, for dependency crates, will be the source directory of those dependencies, not the source directory of the crate that we are working on.

Forcing directory resolution to be relative to the active crate's directory by replacing the rustc-evaluated `.` with a shell-evaluated `$(pwd)` resolves this problem.

Kudos to @bjorn3 for figuring this out!
@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @nikomatsakis (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@XAMPPRocky
Copy link
Member

r? @wesleywiser

Copy link
Member

@wesleywiser wesleywiser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just saw the thread on Zulip. Great job debugging all around!

@wesleywiser
Copy link
Member

@bors r+

@pietroalbini pietroalbini merged commit b48c507 into rust-lang:master Mar 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants