extend bootstrap related documentations #1563

onur-ozkan · 2023-01-20T13:27:34Z

With this diff, I tried to consolidate bootstrap documentations and remove the duplicated informations.

Signed-off-by: ozkanonur work@onurozkan.dev

onur-ozkan · 2023-01-20T13:29:21Z

src/getting-started.md

ehuss

I realize you are just moving some documentation over from another location, but I wanted to point out a few things that didn't look accurate. May want to consider looking at those while making changes here.

src/building/how-to-build-and-run.md

onur-ozkan · 2023-01-23T22:38:37Z

I realize you are just moving some documentation over from another location, but I wanted to point out a few things that didn't look accurate. May want to consider looking at those while making changes here.

Thank you for the review. This is good because this is one of the PRs where it's get driven by review notes.

I will have to read(with more attention) all the docs I copied and update them(in couple days). Because, what I see is there are many outdated informations(it's probably because docs in the codebase are hard to track & keep up-to date).

jyn514 · 2023-01-24T00:05:19Z

I am slightly worried that this makes the getting started documentation even longer ... it's the first section we point people towards, and it's already quite long. Is all of this "user-facing"? Do we think it will help people use the tooling? If not I would lean towards only putting it in the bootstrap readme.

src/building/how-to-build-and-run.md

onur-ozkan · 2023-01-24T07:04:03Z

Is all of this "user-facing"? Do we think it will help people use the tooling? If not I would lean towards only putting it in the bootstrap readme.

I would say it's more like "user-facing information" rather than "internal information". But I agree, it looks way too long right now. I will work on it.

onur-ozkan · 2023-01-26T23:36:16Z

Is all of this "user-facing"? Do we think it will help people use the tooling?

I think there is not a obvious answer to this. It's kind a relative question and I belive this PR is one of the review-driven kind PRs. I tried to move(and update some of them) the informations which I think they can be useful and not so complicated for users. If you think otherwise on some diffs, please point them so I can cut them out from the PR.

@albertlarsan68, @ehuss I am open to your thoughts as well on this PR, if you have any suggestion.

jyn514

I think there is not a obvious answer to this. It's kind a relative question and I belive this PR is one of the review-driven kind PRs. I tried to move(and update some of them) the informations which I think they can be useful and not so complicated for users. If you think otherwise on some diffs, please point them so I can cut them out from the PR.

👍 that makes a lot of sense to me, I left more detailed feedback just now. Thank you for working on this ❤️

src/building/bootstrapping.md

jyn514 · 2023-01-27T03:45:26Z

src/building/bootstrapping.md

+#### Copying stage0 {std,test,rustc}
+
+This copies the build output from Cargo into
+`build/$HOST/stage0-sysroot/lib/rustlib/$ARCH/lib`.
+[comment]: FIXME: this step's documentation should be expanded -- the information already here may be incorrect.
+
+#### Assembling stage1 compiler
+
+This copies the libraries we built in "building stage0 ... artifacts" into
+the stage1 compiler's lib directory. These are the host libraries that the
+compiler itself uses to run. These aren't actually used by artifacts the new
+compiler generates. This step also copies the rustc and rustdoc binaries we
+generated into `build/$HOST/stage/bin`.
+
+The stage1/bin/rustc is a fully functional compiler, but it doesn't yet have
+any libraries to link built binaries or libraries to. The next 3 steps will
+provide those libraries for it; they are mostly equivalent to constructing
+the stage1/bin compiler so we don't go through them individually.
+
+#### Uplifting stage1 {std,test,rustc}


Hmm, all this info looks useful, but it seems redundant with the "Stages of bootstrapping" section at the top. I'm not sure what to do here.

Hmm, all this info looks useful,

Yes, it explains a lot of the build process.

but it seems redundant with the "Stages of bootstrapping" section at the top. I'm not sure what to do here.

It's a little bit(maybe more than little bit) detailed version of it. Do you think this should be under the bootstrap/README.md ?

src/building/how-to-build-and-run.md

src/building/bootstrapping.md

src/building/suggested.md

src/building/bootstrapping.md

src/building/how-to-build-and-run.md

src/building/suggested.md

src/tests/compiletest.md

jyn514

Looks great, thanks!

src/tests/compiletest.md

Signed-off-by: ozkanonur <work@onurozkan.dev>

…cs, r=jyn514 consolidate bootstrap docs With this diff, I tried to consolidate bootstrap documentations and remove the duplicated informations. Coupled with rust-lang/rustc-dev-guide#1563 Resolves rust-lang#90686 Signed-off-by: ozkanonur <work@onurozkan.dev>

Update books ## rust-lang/book 2 commits in f2a78f64b668f63f581203c6bac509903f7c00ee..d94e03a18a2590ed3f1c67b859cb11528d2a2d5c 2023-02-10 16:01:09 UTC to 2023-02-10 15:55:43 UTC - Update to Rust 1.67.1 - Update to Rust 1.66.1 ## rust-embedded/book 1 commits in f1a4614aa41cc544b91b79760a709e113f3451d7..701d1551429da4cb609082c0ac99df569e336710 2023-01-31 12:32:49 UTC to 2023-01-31 12:32:49 UTC - fix: Circled Image not visible on B&W E-Ink screen (rust-embedded/book#339) ## rust-lang/nomicon 2 commits in bd1829d235296952bf72ca55635e360584b8805e..79b53665a7c61d171fb8c5ad0b73b371f9ee6ba7 2023-02-13 08:40:24 UTC to 2023-02-07 09:43:03 UTC - Fixes double bug in Send-Sync example (rust-lang/nomicon#401) - Small language fix in subtyping.md (rust-lang/nomicon#399) ## rust-lang/reference 4 commits in 22882fb3f7b4d69fdc0d1731e8b9cfcb6910537d..e5adb99c04817b7fbe08f4ffce5b36702667345f 2023-02-08 18:09:03 UTC to 2023-02-01 03:49:46 UTC - Eliminate 'half open' terminology from range pattern grammar (rust-lang/reference#1330) - fix place expression context example (rust-lang/reference#1327) - remove confusing words (rust-lang/reference#1324) - Reword "expression for a match arm" (rust-lang/reference#1325) ## rust-lang/rust-by-example 5 commits in 134376872e8c387ef369507e0ee9b5a0e3272718..efe23c4fe12e06351b8dc8c3d18312c761455109 2023-02-06 11:32:23 UTC to 2023-01-31 16:38:03 UTC - fix irrelevant comments (rust-lang/rust-by-example#1676) - remove redudant code (rust-lang/rust-by-example#1675) - Line comments: change 'inside' to 'after' (rust-lang/rust-by-example#1674) - fix incorrect trait bound demonstration (rust-lang/rust-by-example#1673) - fix "High Order Functions" typo (rust-lang/rust-by-example#1672) ## rust-lang/rustc-dev-guide 14 commits in e359ee2..41a96ab 2023-02-11 06:41:56 UTC to 2023-01-31 18:42:30 UTC - Add a citation file (rust-lang/rustc-dev-guide#1550) - Improve git submodule help (rust-lang/rustc-dev-guide#1587) - update examples for rustc 1.69.0-nightly (e1eaa2d 2023-02-06) (rust-lang/rustc-dev-guide#1590) - Replace settings.json with x.py setup note (rust-lang/rustc-dev-guide#1588) - Do not add accept header on linkcheck (rust-lang/rustc-dev-guide#1586) - Fixed small grammar mistake in monomorph.md (rust-lang/rustc-dev-guide#1585) - update bootstrap guide (rust-lang/rustc-dev-guide#1583) - Use host symlink for custom rustup toolchain (rust-lang/rustc-dev-guide#1580) - Fix broken links (rust-lang/rustc-dev-guide#1577) - Add section on comparing types (rust-lang/rustc-dev-guide#1570) - Update rustfmt path (rust-lang/rustc-dev-guide#1574) - fix wrong heading level (rust-lang/rustc-dev-guide#1573) - fix incorrect position of `Clarification of build command's stdout` (rust-lang/rustc-dev-guide#1572) - extend bootstrap related documentations (rust-lang/rustc-dev-guide#1563)

onur-ozkan mentioned this pull request Jan 20, 2023

consolidate bootstrap docs rust-lang/rust#107116

Merged

onur-ozkan commented Jan 20, 2023

View reviewed changes

src/getting-started.md Show resolved Hide resolved

onur-ozkan changed the title ~~extend bootstrap related documentations r=ozkanonur~~ extend bootstrap related documentations Jan 20, 2023

ehuss reviewed Jan 23, 2023

View reviewed changes

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

onur-ozkan changed the title ~~extend bootstrap related documentations~~ wip: extend bootstrap related documentations Jan 23, 2023

jyn514 reviewed Jan 24, 2023

View reviewed changes

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

onur-ozkan force-pushed the consolidate-bootstrap-docs branch 2 times, most recently from 022b3a0 to a637701 Compare January 26, 2023 23:25

onur-ozkan requested a review from jyn514 January 26, 2023 23:36

onur-ozkan changed the title ~~wip: extend bootstrap related documentations~~ extend bootstrap related documentations Jan 26, 2023

jyn514 reviewed Jan 27, 2023

View reviewed changes

onur-ozkan force-pushed the consolidate-bootstrap-docs branch 2 times, most recently from e139fbf to 00c0d7e Compare January 27, 2023 11:26

albertlarsan68 reviewed Jan 27, 2023

View reviewed changes

src/building/bootstrapping.md Outdated Show resolved Hide resolved

src/building/suggested.md Outdated Show resolved Hide resolved

onur-ozkan force-pushed the consolidate-bootstrap-docs branch from 7290944 to bf7b361 Compare January 27, 2023 14:14

jyn514 reviewed Jan 29, 2023

View reviewed changes

src/building/bootstrapping.md Outdated Show resolved Hide resolved

src/building/how-to-build-and-run.md Outdated Show resolved Hide resolved

src/building/suggested.md Outdated Show resolved Hide resolved

src/tests/compiletest.md Outdated Show resolved Hide resolved

onur-ozkan force-pushed the consolidate-bootstrap-docs branch 2 times, most recently from 7d5f5d2 to bc35921 Compare January 30, 2023 08:34

onur-ozkan requested a review from jyn514 January 30, 2023 08:34

onur-ozkan force-pushed the consolidate-bootstrap-docs branch from 2385520 to 3e681d1 Compare January 30, 2023 08:35

jyn514 approved these changes Jan 31, 2023

View reviewed changes

src/tests/compiletest.md Outdated Show resolved Hide resolved

extend bootstrap related documentations

ab5d6f2

Signed-off-by: ozkanonur <work@onurozkan.dev>

onur-ozkan force-pushed the consolidate-bootstrap-docs branch from 18276a0 to ab5d6f2 Compare January 31, 2023 17:14

jyn514 merged commit 472188e into rust-lang:master Jan 31, 2023

onur-ozkan deleted the consolidate-bootstrap-docs branch January 31, 2023 20:35

rustbot mentioned this pull request Feb 13, 2023

Update books rust-lang/rust#108002

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

extend bootstrap related documentations #1563

extend bootstrap related documentations #1563

onur-ozkan commented Jan 20, 2023 •

edited

Loading

onur-ozkan commented Jan 20, 2023

ehuss left a comment

onur-ozkan commented Jan 23, 2023 •

edited

Loading

jyn514 commented Jan 24, 2023

onur-ozkan commented Jan 24, 2023 •

edited

Loading

onur-ozkan commented Jan 26, 2023 •

edited

Loading

jyn514 left a comment

jyn514 Jan 27, 2023

onur-ozkan Jan 27, 2023

jyn514 left a comment

extend bootstrap related documentations #1563

extend bootstrap related documentations #1563

Conversation

onur-ozkan commented Jan 20, 2023 • edited Loading

onur-ozkan commented Jan 20, 2023

ehuss left a comment

Choose a reason for hiding this comment

onur-ozkan commented Jan 23, 2023 • edited Loading

jyn514 commented Jan 24, 2023

onur-ozkan commented Jan 24, 2023 • edited Loading

onur-ozkan commented Jan 26, 2023 • edited Loading

jyn514 left a comment

Choose a reason for hiding this comment

jyn514 Jan 27, 2023

Choose a reason for hiding this comment

onur-ozkan Jan 27, 2023

Choose a reason for hiding this comment

jyn514 left a comment

Choose a reason for hiding this comment

onur-ozkan commented Jan 20, 2023 •

edited

Loading

onur-ozkan commented Jan 23, 2023 •

edited

Loading

onur-ozkan commented Jan 24, 2023 •

edited

Loading

onur-ozkan commented Jan 26, 2023 •

edited

Loading