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.

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

Simplify "how to build and run" section #1528

Merged
merged 5 commits into from Jan 1, 2023

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Dec 8, 2022

See a detailed explanation in the commit messages. This is a companion PR to rust-lang/rust#105465 and should not be merged before.

  • Update sentence about LLVM to match the new defaults
  • Move information about dependencies to the rust-lang/rust readme
  • Move "create a config.toml" after the section explaning x.py
  • Remove unnecessary detail in building chapter
  • Remove initial section on submodules

It's not necessary and it takes up valuable space at the very start of the guide.
Most of these details were not helpful or necessary for building the compiler for the first time.
This section comes very early in the guide and is meant to be a tutorial, so being concise is very important.
This avoids having to maintain the information in two places.
@JohnTitor JohnTitor added the blocked This PR is blocked waiting for some other PR label Dec 8, 2022
@tshepang
Copy link
Member

tshepang commented Dec 8, 2022

* Move information about dependencies to the rust-lang/rust readme

should we not rather have this here, since we can use date-check

@jyn514
Copy link
Member Author

jyn514 commented Dec 17, 2022

@tshepang I don't want to have it in both places, and having a link to the dev-guide in the rust-lang/rust readme seems unfortunate if it's just for a single line ... I don't think it's critical to have the version of LLVM exactly correct, since the minimum version of g++ doesn't change that much, and it was already wrong before if you were using system llvm.

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Dec 24, 2022
Improve top-level docs

See a detailed explanation in the commit messages. This is a companion PR to rust-lang/rustc-dev-guide#1528.

* Link to other resources instead of inlining their information
* Remove ancient and outdated reference to `config.mk`
* Suggest `profile = "user"` in the README
* Add detail about dependencies from the dev-guide
* Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme
* Link to `std-dev-guide` in CONTRIBUTING.md
@jyn514 jyn514 removed the blocked This PR is blocked waiting for some other PR label Jan 1, 2023
@jyn514
Copy link
Member Author

jyn514 commented Jan 1, 2023

rust-lang/rust#105465 was merged :)

@jyn514 jyn514 merged commit ef12db3 into rust-lang:master Jan 1, 2023
@jyn514 jyn514 deleted the simplify-building branch January 1, 2023 05:20
compiler-errors added a commit to compiler-errors/rust that referenced this pull request Jan 2, 2023
Update books

## rust-lang/book

3 commits in a60f4316ec923a5ac2ed6a2eba6960edb832d855..2bd5d42c9956369132228da6409f0e68da56c51a
2022-12-22 21:37:10 UTC to 2022-12-22 21:36:14 UTC

- fix macos installation problem (rust-lang/book#3469)
- Update -guessing-game-tutorial incorrect output (rust-lang/book#3462)
- FIX: IT repo updated (rust-lang/book#3454)

## rust-lang/nomicon

1 commits in dd37e21ccee43918ed18a71581bb2af537ffe4fc..8ca261268068d80c0969260fff15199bad87b587
2022-12-30 16:32:09 UTC to 2022-12-30 16:32:09 UTC

- Discourage the use of transmute to construct invalid values (rust-lang/nomicon#388)

## rust-lang/rust-by-example

6 commits in 995df09b65c582eb6290ab7ea5d9485983eb4c37..8888f9428fe9a48f31de6bd2cef9b9bf80791edc
2023-01-01 12:53:50 UTC to 2022-12-21 10:18:31 UTC

- types/alias: use io::{Result,Error} instead of Io{Result,Error} (rust-lang/rust-by-example#1660)
- Fix sample code mismatching its comments (rust-lang/rust-by-example#1659)
- fix: add missing space (rust-lang/rust-by-example#1658)
- diverging: fix issues with example code (rust-lang/rust-by-example#1631)
- Update enum.md (rust-lang/rust-by-example#1645)
- Clean up Chapter 2 (Primitives) (rust-lang/rust-by-example#1651)

## rust-lang/rustc-dev-guide

5 commits in 8b42eb5f57d3d8ed2257a22d0e850d9db52afed3..b3e2a6e6c8a3aae5b5d950c63046f23bae07096d
2023-01-01 05:20:47 UTC to 2022-12-25 12:11:21 UTC

- Add help for when you update a submodule by accident (rust-lang/rustc-dev-guide#1537)
- Simplify "how to build and run" section (rust-lang/rustc-dev-guide#1528)
- Replace `$TARGET` with `host` (rust-lang/rustc-dev-guide#1514)
- Add more rebasing help (rust-lang/rustc-dev-guide#1536)
- Fix rustc_borrowck crate name typo (rust-lang/rustc-dev-guide#1535)
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.

None yet

3 participants