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.

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

docs(contrib): Point compilation docs to doc comments #11841

Merged
merged 1 commit into from
Mar 13, 2023
Merged

docs(contrib): Point compilation docs to doc comments #11841

merged 1 commit into from
Mar 13, 2023

Conversation

epage
Copy link
Contributor

@epage epage commented Mar 13, 2023

This is a follow up to #11809, merging the description of compilation with what is in the source code, leaving a breadcrumb for people who were used to going to the old page (for now). The new entry point for finding this is the doc comment in lib.rs

Like with #11809, this also meant increasing the visibility of a mod. This mod is mostly re-exported already, so this doesn't seem too bad. I pointed directly to the job _queue mod rather than JobQueue because the mod had more of an architecture discussion. For drain_the_queue, I also pointed at the mod because it talks about it and this avoided making DrainState and drain_the_queue pub(crate).

This still leaves

  • Files
    • Part of this indexes the architecture based on files generated and should be in lib.rs
    • Part of this is filesystem best practices and should be moved out of the architecture overview into some kind of Implementation Practices
  • Package and Resolution
  • Console Output. This also likely belongs in an Implementation section
  • Likely stuff in the testing section

@epage
docs(contrib): Point compilation docs to doc comments
e148231 
I also verified that `src/cargo/lib.rs` points people to this location
for learning about compilation.
@rustbot
Copy link
Collaborator

rustbot commented Mar 13, 2023

r? @weihanglo

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

@rustbot rustbot added A-build-execution Area: anything dealing with executing the compiler A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 13, 2023
epage added a commit to epage/cargo that referenced this pull request Mar 13, 2023
@epage
docs(contrib): Move Design Principles earlier in the book
67ca847 
This is the framing by which all contributions should happen, so this
should come first before getting into what is needed to know to
implement a change and test it.

This is also prep for adding a new Implementations Practices section to
pull out various tips spread through the Architecture section.  See rust-lang#11841
@epage epage mentioned this pull request Mar 13, 2023
Merged
weihanglo
weihanglo approved these changes Mar 13, 2023
View reviewed changes
Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

Looks good. Thank you!

@weihanglo
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented Mar 13, 2023

📌 Commit e148231 has been approved by weihanglo

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-review Status: Awaiting review from the assignee but also interested parties. labels Mar 13, 2023
@bors
Copy link
Contributor

bors commented Mar 13, 2023

⌛ Testing commit e148231 with merge 92751f9...

@bors
Copy link
Contributor

bors commented Mar 13, 2023

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 92751f9 to master...

bors added a commit that referenced this pull request Mar 13, 2023
@bors
Auto merge of #11842 - epage:design, r=ehuss
71ea049 
docs(contrib): Move Design Principles earlier in the book

This is the framing by which all contributions should happen, so this should come first before getting into what is needed to know to implement a change and test it.

This is also prep for adding a new Implementations Practices section to pull out various tips spread through the Architecture section.  See #11841
@bors bors merged commit 92751f9 into rust-lang:master Mar 13, 2023
@epage epage deleted the contrib branch March 13, 2023 21:46
weihanglo added a commit to weihanglo/rust that referenced this pull request Mar 14, 2023
@weihanglo
Update cargo
3c7df56 
14 commits in 7d3033d2e59383fd76193daf9423c3d141972a7d..4a3c588b1f0a8e2dc8dd8789dbf3b6a71b02ed49
2023-03-08 17:05:08 +0000 to 2023-03-14 14:05:36 +0000
- ci: make clean-test-output a script for reuse (rust-lang/cargo#11848)
- Accurately show status when downgrading dependencies (rust-lang/cargo#11839)
- docs(contrib): Move Design Principles earlier in the book (rust-lang/cargo#11842)
- docs(contrib): Point compilation docs to doc comments (rust-lang/cargo#11841)
- `cargo install --git` multiple packages with binaries found hint (rust-lang/cargo#11835)
- Disable flaky auth tests when `gitoxide` runs them (rust-lang/cargo#11830)
- Add some documentation on writing cross-compilation tests (rust-lang/cargo#11825)
- chore: Use sparse protocol on stable CI (rust-lang/cargo#11829)
- Notice for potential unexpected shell expansions in help text of `cargo-add` (rust-lang/cargo#11826)
- Add tracking issue to gitoxide unstable docs (rust-lang/cargo#11822)
- Bump crates-io to 0.36.0 (rust-lang/cargo#11820)
- Bump to 0.71.0; update changelog (rust-lang/cargo#11815)
- docs(contrib): Move overview to lib (rust-lang/cargo#11809)
- Fix semver check for 1.68 (rust-lang/cargo#11817)
@weihanglo weihanglo mentioned this pull request Mar 14, 2023
Merged
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Mar 15, 2023
@Dylan-DPC
Rollup merge of rust-lang#109150 - weihanglo:update-cargo, r=weihanglo
a08516b 
Update cargo

14 commits in 7d3033d2e59383fd76193daf9423c3d141972a7d..4a3c588b1f0a8e2dc8dd8789dbf3b6a71b02ed49
2023-03-08 17:05:08 +0000 to 2023-03-14 14:05:36 +0000
- ci: make clean-test-output a script for reuse (rust-lang/cargo#11848)
- Accurately show status when downgrading dependencies (rust-lang/cargo#11839)
- docs(contrib): Move Design Principles earlier in the book (rust-lang/cargo#11842)
- docs(contrib): Point compilation docs to doc comments (rust-lang/cargo#11841)
- `cargo install --git` multiple packages with binaries found hint (rust-lang/cargo#11835)
- Disable flaky auth tests when `gitoxide` runs them (rust-lang/cargo#11830)
- Add some documentation on writing cross-compilation tests (rust-lang/cargo#11825)
- chore: Use sparse protocol on stable CI (rust-lang/cargo#11829)
- Notice for potential unexpected shell expansions in help text of `cargo-add` (rust-lang/cargo#11826)
- Add tracking issue to gitoxide unstable docs (rust-lang/cargo#11822)
- Bump crates-io to 0.36.0 (rust-lang/cargo#11820)
- Bump to 0.71.0; update changelog (rust-lang/cargo#11815)
- docs(contrib): Move overview to lib (rust-lang/cargo#11809)
- Fix semver check for 1.68 (rust-lang/cargo#11817)

r? `@ghost`
@ehuss ehuss added this to the 1.70.0 milestone Mar 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weihanglo weihanglo weihanglo approved these changes

Assignees

@weihanglo weihanglo

Labels
A-build-execution Area: anything dealing with executing the compiler A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.70.0
Development

Successfully merging this pull request may close these issues.
5 participants
@epage @rustbot @weihanglo @bors @ehuss