Skip to content

Improve top-level docs #105465

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Dec 24, 2022
Merged

Improve top-level docs #105465

merged 4 commits into from
Dec 24, 2022

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Dec 8, 2022 •
edited
Loading

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

@rustbot
Copy link
Collaborator

rustbot commented Dec 8, 2022

r? @Mark-Simulacrum

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

@rustbot rustbot added A-meta Area: Issues & PRs about the rust-lang/rust repository itself S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 8, 2022
@jyn514 jyn514 mentioned this pull request Dec 8, 2022
Merged
@rustbot rustbot added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Dec 8, 2022
jyn514
jyn514 commented Dec 8, 2022
View reviewed changes
jyn514
jyn514 commented Dec 8, 2022
View reviewed changes
Mark-Simulacrum
Mark-Simulacrum reviewed Dec 10, 2022
View reviewed changes
@Mark-Simulacrum Mark-Simulacrum added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 10, 2022
@jyn514 jyn514 added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 17, 2022
Mark-Simulacrum
Mark-Simulacrum reviewed Dec 17, 2022
View reviewed changes
README.md

* `g++` 5.1 or later or `clang++` 3.5 or later
Copy link
Member

Choose a reason for hiding this comment

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

I think we probably have C/C++ dependencies somewhere in the compiler tree? At minimum, these are needed for any Rust compilation as we typically invoke the linker through cc, right? (Not sure about Windows, but I believe this is the case on Ubuntu at least).

Copy link
Member Author

Choose a reason for hiding this comment

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

We need at least cc, but not a full C++ compiler. I can say that explicitly if you like, but I think most people assume they need at least a C compiler for most things.

Copy link
Member

Choose a reason for hiding this comment

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

Hm. I guess I would probably not call that an implicit assumption we can make; I think we should say it. Folks coming from languages like Node or Python might not realize that they need extra compilers to work on std, for example.

(And long-term I think we should try to remove this system dependency, e.g., by including clang in our artifacts. But that's a very separate conversation).

@Mark-Simulacrum
Copy link
Member

r=me with last comment resolved and commits squashed (at least a bit)

@Mark-Simulacrum Mark-Simulacrum added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 23, 2022
@jyn514
Link to other resources instead of inlining their information
a06e5de 
The other places are more accurate and up-to-date.

- Link to `std-dev-guide` in CONTRIBUTING.md

  Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library.

- Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme

  CONTRIBUTING.md has more information and also links the std-dev-guide.

- Link to forge for the list of tested platforms; the one in the readme
  was hopelessly out of date.
@jyn514
Add detail about dependencies from the dev-guide
7dae1b0 
The goal is to remove this altogether from the dev-guide once this PR is merged.
@jyn514
Suggest profile = "user" in the README
1bd1b25 
This sets several useful defaults, like `extended = true`, and gives us a path forward for changing
global defaults without breaking distros.
@jyn514
Remove ancient and outdated references to config.mk
70a0e0a
@jyn514
Copy link
Member Author

jyn514 commented Dec 24, 2022

@bors r=Mark-Simulacrum rollup

@bors
Copy link
Collaborator

bors commented Dec 24, 2022

📌 Commit 70a0e0a has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 24, 2022
@matthiaskrgr matthiaskrgr mentioned this pull request Dec 24, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 24, 2022
@bors
Auto merge of rust-lang#106111 - matthiaskrgr:rollup-nnpoe5h, r=matth…
8766bbd 
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#105465 (Improve top-level docs)
 - rust-lang#105872 (Suggest remove last method call when type coerce with expected  type)
 - rust-lang#106032 (std: only use LFS function on glibc)
 - rust-lang#106078 (Provide more context on FileCheck failures)
 - rust-lang#106100 (Codegen test for derived `<` on trivial newtype [TEST ONLY])
 - rust-lang#106109 (rustdoc: make line number CSS for doc comment and scraped the same)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 9ae9880 into rust-lang:master Dec 24, 2022
@rustbot rustbot added this to the 1.68.0 milestone Dec 24, 2022
@atouchet atouchet mentioned this pull request Dec 24, 2022
Closed
@jyn514 jyn514 deleted the docs branch February 25, 2023 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mark-Simulacrum Mark-Simulacrum Mark-Simulacrum left review comments

Assignees

@Mark-Simulacrum Mark-Simulacrum

Labels
A-meta Area: Issues & PRs about the rust-lang/rust repository itself S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
1.68.0
Development

Successfully merging this pull request may close these issues.
4 participants
@jyn514 @rustbot @Mark-Simulacrum @bors