issue-130 copy contents related x.py from rust-forge to rustc-guide #195

rajcspsg · 2018-09-07T00:15:05Z

No description provided.

mark-i-m

Thanks @rajcspsg! Nice work :)

I left some comments. I think this is a great starting point, and just needs a bit of adjusting.

mark-i-m · 2018-09-11T00:35:34Z

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

@@ -110,6 +110,44 @@ This is just a subset of the full rustc build. The **full** rustc build
 - Build libstd with stage2 compiler.
 - Build librustdoc and a bunch of other things.

+### Build different stages


#191 Is documenting this extensively, so I think we don't need this section.

mark-i-m · 2018-09-11T00:43:50Z

src/what-is-x-py.md

@@ -0,0 +1,42 @@
+# what is x.py?


I think the information in this file can be merged into how-to-build-and-run.md.

This first paragraph (under what is x.py) could become the first paragraph of the "Running x.py and building a stage1 compiler" section.

The information on extra build flags could be merged into "Other x.py commands".

The information after line 31 is redundant with #191.

mark-i-m · 2018-09-11T00:45:36Z

src/tests/running.md

@@ -70,3 +70,26 @@ This is much faster, but doesn't always work. For example, some tests
 include directives that specify specific compiler flags, or which rely
 on other crates, and they may not run the same without those options.

+### Run specific tests


Perhaps remove this section title. I think these subsections fit reasonably well under Running an individual test.

mark-i-m · 2018-09-11T00:45:54Z

src/tests/running.md

@@ -70,3 +70,26 @@ This is much faster, but doesn't always work. For example, some tests
 include directives that specify specific compiler flags, or which rely
 on other crates, and they may not run the same without those options.

+### Run specific tests
+
+# Run only the tidy script


This should be ###... same for the others

mark-i-m · 2018-09-11T00:46:58Z

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

-> rustup toolchain link stage1 build/<host-triple>/stage1
-> rustup toolchain link stage2 build/<host-triple>/stage2
+  rustup toolchain link stage1 build/<host-triple>/stage1
+  rustup toolchain link stage2 build/<host-triple>/stage2


We actually want the > prompts for consistency with other chapters.

mark-i-m · 2018-09-11T00:53:59Z

src/compiler-benchmarking.md

@@ -0,0 +1,11 @@
+# Benchmarking rustc


Hmm... @nnethercote are these benchmarks maintained and still useful?

I hadn't heard of these. I just tried ./x.py bench, it looks like it's basically the same as cargo bench, i.e. it runs #[bench] unit benchmarks. That might be useful for benchmarking certain components within the compiler (mostly libraries in std) but it doesn't give any info on the overall speed of the compiler. Also, I got compile errors for a bunch of these, so it looks like they aren't being run regularly.

@rajcspsg Perhaps we should remove this section/file altogether then? It seems to be outdated.

this file is removed.

src/compiler-documenting.md

mark-i-m · 2018-09-11T00:56:12Z

src/compiler-documenting.md

+You might want to build documentation of the various components 
+available like the standard library. There’s two ways to go about this.
+ You can run rustdoc directly on the file to make sure the HTML is 
+ correct which is fast or you can build the documentation as part of the 


"correct which is fast or" -> "correct, which is fast. Alternately, "

this is done.

mark-i-m · 2018-09-11T01:01:22Z

src/compiler-documenting.md

+ the documentation you want.
+
+## Document internal rustc items
+By default rustc does not build the compiler docs for its internal items. 


@davidtwco Is this still true? How is the rustc rustdoc built?

Compiler documentation is not built by default - there's a config.toml flag for that. But, when enabled, compiler documentation does include internal items.

@rajcspsg Perhaps we can replace the first paragraph in this section (and the cp config.toml.example ... snippet) with what davidtwco wrote in the comment directly above?

this is done

src/compiler-documenting.md

rajcspsg · 2018-09-18T22:07:50Z

@mark-i-m - I've incorporated the comments except below ones.

https://github.com/rust-lang-nursery/rustc-guide/pull/195/files#r216517973
https://github.com/rust-lang-nursery/rustc-guide/pull/195/files#r216518863
#195 (comment)
#195 (comment)

I need clarifications for your 2 comments and I have replied to your comments accordingly.
Please review and let me know if you have more comments.

rajcspsg · 2018-09-25T00:59:27Z

@mark-i-m please let me know your thoughts on pending items I mentioned above.

mark-i-m · 2018-09-25T15:29:40Z

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

@@ -47,6 +47,14 @@ debuginfo-lines = true
 use-jemalloc = false
 ```

+### what is x.py?


Nit: "what" -> "What"

This is done.

mark-i-m · 2018-09-25T15:34:55Z

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

+    -h, --help          print this help message
+```
+
+One thing to keep in mind is that `rustc` is a _bootstrapping_ compiler. That


This is already discussed in the previous section. I think we don't need lines added 114-136.

EDIT: i.e. from "One thing to keep in mind" to "unless something has broken".

This is done.

mark-i-m · 2018-09-25T15:38:16Z

src/tests/running.md

@@ -93,3 +93,24 @@ This is much faster, but doesn't always work. For example, some tests
 include directives that specify specific compiler flags, or which rely
 on other crates, and they may not run the same without those options.

+### Run only the tidy script


Perhaps move these to the end of the "Running a subset of the test suites" section above (in the same file).

This is done.

mark-i-m · 2018-09-25T15:47:21Z

@rajcspsg Thanks! Sorry for the delay. I have been a bit swamped lately... I left some comments (and I think I answered your questions; let me know if I haven't). Overall, this is looking good :)

rajcspsg · 2018-09-26T14:36:46Z

@mark-i-m I have updated with your feedback. Please check and let me know if any changes are required.

mark-i-m · 2018-09-29T01:48:54Z

src/build-install-distribution-artifacts.md

+
+   Note: If you are testing out a modification to a compiler, you might want to use it to compile some project.
+   Usually, you do not want to use ./x.py install for testing.
+   Rather, you should create a toolchain as discussed in how-to-build-and-run.html#creating-a-rustup-toolchain.


Could you make this a link to the actual chapter please?

mark-i-m · 2018-09-29T01:51:08Z

src/build-install-distribution-artifacts.md

+   Note: If you are testing out a modification to a compiler, you might want to use it to compile some project.
+   Usually, you do not want to use ./x.py install for testing.
+   Rather, you should create a toolchain as discussed in how-to-build-and-run.html#creating-a-rustup-toolchain.
+   For example, if the toolchain you created is called foo, you would then invoke it with rustc +foo ... (where ... represents the rest of the arguments).


Could you put the rustc +foo ... part in backticks so it formats as monospace font?

mark-i-m · 2018-09-29T01:54:02Z

@rajcspsg Looking good! To minor nits, then r=me 👍

Nice job :)

mark-i-m · 2018-09-29T03:35:53Z

src/build-install-distribution-artifacts.md

+   the rest of the arguments).
+
+[create-rustup-toolchain]: https://github.com/rust-lang-nursery/rustc-guide/blob/master/src/how-to-build-and-run.md#creating-a-rustup-toolchain


Sorry, I should have been more clear. This should be ./how-to-build-and-run.md#creating-a-rustup-toolchain

Does the below one work?
[create-rustup-toolchain]: ./how-to-build-and-run.md#creating-a-rustup-toolchain

mark-i-m · 2018-09-29T13:51:07Z

👍 Thanks!

rajcspsg · 2018-09-30T02:59:07Z

@mark-i-m does this PR covers the 4th point in this issue?

rajcspsg mentioned this pull request Sep 7, 2018

Move the documentation related to ./x.py from https://forge.rust-lang.org #130

Closed

rajcspsg force-pushed the issue-130 branch 7 times, most recently from 6d1e5a2 to 8c20957 Compare September 7, 2018 01:17

mark-i-m suggested changes Sep 11, 2018

View reviewed changes

issue-130 copy contents related x.py from rust-forge

d7c7678

rajcspsg force-pushed the issue-130 branch 2 times, most recently from 19bbd6e to 9963b90 Compare September 18, 2018 21:57

rajcspsg force-pushed the issue-130 branch 6 times, most recently from 4b292c1 to 2b0fac8 Compare September 24, 2018 23:57

issue-130 incorporate the review comments

9633015

rajcspsg force-pushed the issue-130 branch from 2b0fac8 to 9633015 Compare September 25, 2018 00:31

mark-i-m reviewed Sep 25, 2018

View reviewed changes

issue-130 updated the review comments

9a3d5e6

rajcspsg force-pushed the issue-130 branch from 8ff9f4a to 9a3d5e6 Compare September 26, 2018 14:40

mark-i-m reviewed Sep 29, 2018

View reviewed changes

rajcspsg force-pushed the issue-130 branch 3 times, most recently from 85cae14 to a895d37 Compare September 29, 2018 03:14

mark-i-m reviewed Sep 29, 2018

View reviewed changes

rajcspsg force-pushed the issue-130 branch from a895d37 to 5cd6b44 Compare September 29, 2018 03:51

updated with review comments

1c8097b

rajcspsg force-pushed the issue-130 branch from 5cd6b44 to 1c8097b Compare September 29, 2018 04:01

mark-i-m merged commit ceff08f into rust-lang:master Sep 29, 2018

rajcspsg deleted the issue-130 branch September 30, 2018 02:59

rajcspsg mentioned this pull request Oct 5, 2018

Link to internal rustdocs #100

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

issue-130 copy contents related x.py from rust-forge to rustc-guide #195

issue-130 copy contents related x.py from rust-forge to rustc-guide #195

rajcspsg commented Sep 7, 2018

mark-i-m left a comment

mark-i-m Sep 11, 2018

mark-i-m Sep 11, 2018

mark-i-m Sep 11, 2018

mark-i-m Sep 11, 2018

mark-i-m Sep 11, 2018

mark-i-m Sep 11, 2018

nnethercote Sep 18, 2018

mark-i-m Sep 25, 2018

rajcspsg Sep 26, 2018

mark-i-m Sep 11, 2018

rajcspsg Sep 26, 2018

mark-i-m Sep 11, 2018

davidtwco Sep 18, 2018

mark-i-m Sep 25, 2018

rajcspsg Sep 26, 2018

rajcspsg commented Sep 18, 2018

rajcspsg commented Sep 25, 2018

mark-i-m Sep 25, 2018

rajcspsg Sep 26, 2018

mark-i-m Sep 25, 2018 •

edited

Loading

rajcspsg Sep 26, 2018

mark-i-m Sep 25, 2018

rajcspsg Sep 26, 2018

mark-i-m commented Sep 25, 2018

rajcspsg commented Sep 26, 2018

mark-i-m Sep 29, 2018

mark-i-m Sep 29, 2018

mark-i-m commented Sep 29, 2018

mark-i-m Sep 29, 2018

rajcspsg Sep 29, 2018 •

edited

Loading

mark-i-m commented Sep 29, 2018

rajcspsg commented Sep 30, 2018

		the rest of the arguments).

		[create-rustup-toolchain]: https://github.com/rust-lang-nursery/rustc-guide/blob/master/src/how-to-build-and-run.md#creating-a-rustup-toolchain

issue-130 copy contents related x.py from rust-forge to rustc-guide #195

issue-130 copy contents related x.py from rust-forge to rustc-guide #195

Conversation

rajcspsg commented Sep 7, 2018

mark-i-m left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajcspsg commented Sep 18, 2018

rajcspsg commented Sep 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mark-i-m Sep 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mark-i-m commented Sep 25, 2018

rajcspsg commented Sep 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mark-i-m commented Sep 29, 2018

Choose a reason for hiding this comment

rajcspsg Sep 29, 2018 • edited Loading

Choose a reason for hiding this comment

mark-i-m commented Sep 29, 2018

rajcspsg commented Sep 30, 2018

mark-i-m Sep 25, 2018 •

edited

Loading

rajcspsg Sep 29, 2018 •

edited

Loading