Skip to content

Improve contributing instructions #1615

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
Nov 8, 2020

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Oct 31, 2020

This builds on the changes from #1612 and should not be merged before.

  • Fix incorrect comment
  • Recommend x.py setup over manually editing config.toml
  • Link to rustc-dev-guide

@jyn514
Copy link
Member Author

jyn514 commented Oct 31, 2020

For reference, these are the current compiler defaults for x.py setup:

$ cat src/bootstrap/defaults/config.compiler.toml 
# These defaults are meant for contributors to the compiler who do not modify codegen or LLVM
[rust]
# This enables `RUSTC_LOG=debug`, avoiding confusing situations
# where adding `debug!()` appears to do nothing.
# However, it makes running the compiler slightly slower.
debug-logging = true
# This greatly increases the speed of rebuilds, especially when there are only minor changes. However, it makes the initial build slightly slower.
incremental = true

[llvm]
# Will download LLVM from CI if available on your platform (Linux only for now)
# https://github.com/rust-lang/rust/issues/77084 tracks support for more platforms
download-ci-llvm = "if-available"

@bors
Copy link
Contributor

bors commented Nov 7, 2020

☔ The latest upstream changes (presumably #1612) made this pull request unmergeable. Please resolve the merge conflicts.

Note that reviewers usually do not review pull requests until merge conflicts are resolved! Once you resolve the conflicts, you should change the labels applied by bors to indicate that your PR is ready for review. Post this as a comment to change the labels:

@rustbot modify labels: +S-waiting-on-review -S-waiting-on-author

@jyn514 jyn514 force-pushed the contributing-instructions branch from 5c38d16 to f196aeb Compare November 7, 2020 20:35
- Fix incorrect comment
- Recommend `x.py setup` over manually editing config.toml
- Link to rustc-dev-guide
@jyn514 jyn514 force-pushed the contributing-instructions branch from f196aeb to 43ce2c2 Compare November 7, 2020 20:37
@RalfJung
Copy link
Member

RalfJung commented Nov 7, 2020

Thanks! @bors r+

@bors
Copy link
Contributor

bors commented Nov 7, 2020

📌 Commit 43ce2c2 has been approved by RalfJung

@bors
Copy link
Contributor

bors commented Nov 7, 2020

⌛ Testing commit 43ce2c2 with merge 66a58d4...

@bors
Copy link
Contributor

bors commented Nov 8, 2020

☀️ Test successful - checks-actions
Approved by: RalfJung
Pushing 66a58d4 to master...

@bors bors merged commit 66a58d4 into rust-lang:master Nov 8, 2020
@jyn514 jyn514 deleted the contributing-instructions branch November 8, 2020 00:35
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.

3 participants