Update build instructions for rustdoc #1117

dns2utf8 · 2021-04-28T15:52:58Z

Hi all

I updated the build instructions with all the things I learned while building the docs.
Thank you @GuillaumeGomez for helping me!

Cheers,
Stefan

GuillaumeGomez · 2021-04-28T15:55:30Z

src/rustdoc.md

+Now build ´rustdoc´ from stage 2 and build the documentation of the standard library:
+
+```bash
+x.py doc std --stage 2 --open


Normally, stage 1 is supposed to be working. Maybe open an issue on the rust repository about it?

I would rather just recommend --stage 1.

I did rebuild it with the current master something fixed the build process there.
Now stage 1 works too, but it is ~38min on an 8 core CPU.

Stage 1 should never be slower than stage 2. I saw below that stage2 took you about 23 minutes - did you maybe have rustdoc already compiled or something?

I enabled [llvm] download-ci-llvm = true in /config.toml so I did not compile LLVM if I understand correctly

Ok, cool. Let's change this to --stage 1 then (~~or just omit the stage, the default is correct~~ no it's not, I forgot doc is different).

GuillaumeGomez · 2021-04-28T15:55:55Z

src/rustdoc.md

+x.py doc std --stage 2 --open
+```
+
+**Note:** `--open` fixes build errors with `libtest`.


Normally no, it's not supposed to be linked in any way. I think it's stage 2 here which fixed it.

I am rerunning this to verify, my gut feeling agrees with you

What do you mean by build errors? Documenting with stage 1 works fine for me locally.

I replied in the bottom, sorry for the confusion

src/rustdoc.md

JohnTitor · 2021-04-28T16:01:43Z

src/rustdoc.md

+# =============================================================================
+# Global Settings
+# =============================================================================
+
+# Use different pre-set defaults than the global defaults.
+#
+# See `src/bootstrap/defaults` for more information.
+# Note that this has no default value (x.py uses the defaults in `config.toml.example`).
+#profile = <none>
+#
+# make sure that you do not have a profile set
+
+# =============================================================================
+# Tweaking how LLVM is compiled
+# =============================================================================


Suggested change

# =============================================================================

# Global Settings

# =============================================================================

# Use different pre-set defaults than the global defaults.

#

# See `src/bootstrap/defaults` for more information.

# Note that this has no default value (x.py uses the defaults in `config.toml.example`).

#profile = <none>

#

# make sure that you do not have a profile set

# =============================================================================

# Tweaking how LLVM is compiled

# =============================================================================

The comment here doesn't seem to be related to the topic, let's shrink it.

I reduced the amount of text, but would leave some comments

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

jyn514 · 2021-04-28T16:07:56Z

src/rustdoc.md

+
+Preconfigure your `/config.toml`:
+
+```toml


This is all way overkill. I would suggest x.py setup tools and nothing else.

I had "libraries" configured before and the setup would not touch the file anymore, so I decided to do it by hand. Is this intended behaviour?

Ok, then I would recommend profile = "tools" instead - that applies the latest changes automatically and also means you don't need to copy/paste 20 lines of config.

Are the implications for the "tools" profile documented somewhere? I would like to link to it

All the profiles are documented in bootstrap itself, or otherwise it would get out of date: https://github.com/rust-lang/rust/blob/master/src/bootstrap/defaults/config.tools.toml

jyn514 · 2021-04-28T16:08:20Z

src/rustdoc.md

+Now build ´rustdoc´ from stage 2 and build the documentation of the standard library:
+
+```bash
+x.py doc std --stage 2 --open


I would rather just recommend --stage 1.

jyn514 · 2021-04-28T16:08:48Z

src/rustdoc.md

+x.py doc std --stage 2 --open
+```
+
+**Note:** `--open` fixes build errors with `libtest`.


What do you mean by build errors? Documenting with stage 1 works fine for me locally.

GuillaumeGomez · 2021-04-28T16:12:41Z

@jyn514 In his case, it's triggering errors about "libtest not found". Which is why I recommended him to try with --stage 2 and to open an issue.

jyn514 · 2021-04-28T16:55:48Z

@GuillaumeGomez that's fine, but we should help @dns2utf8 get --stage 1 working instead of recommending a command that takes twice as long.

dns2utf8 · 2021-04-28T17:14:41Z

In my opinion building from stage 2 and the CI artefacts should be possible in ~5min or less, but my current test gave me ~23min. So not that great either

dns2utf8 · 2021-04-28T17:19:21Z

The build error I was getting:

rust/build/x86_64-unknown-linux-gnu/stage1/bin/rustdoc: error while loading shared libraries: http://libtest-767351f2ae2fb418.so: cannot open shared object file: No such file or directory
error: could not document `core`

I fixed this by building the docs with the master branch at 855c2d130fb70da1643cf8f696c7aad7537aef34 and then switching to my branch that has mostly JavaScript/CSS differences

jyn514 · 2021-05-02T15:45:58Z

In my opinion building from stage 2 and the CI artefacts should be possible in ~5min or less, but my current test gave me ~23min. So not that great either

It should be less than ~3 minutes if you set download-rustc = true. profile = tools does that by default.

jyn514 · 2021-07-03T15:34:56Z

Hi @dns2utf8, are you planning to work on this?

src/rustdoc.md

JohnTitor · 2022-11-20T04:05:42Z

Triage: I'm going to close this as inactive, but feel free to open another PR if anyone is still interested in this change (I think https://github.com/rust-lang/rustc-dev-guide/pull/1389/files#diff-d9ae61aa6e37d7cc365c1ae1c66c801e2741026fbc752d4628dc34f3c5ce9290 updated some instructions but the "Fast builds (for tier 1 targets)" section might be still useful). Thanks for contributing!

Add faster build tutorial and update cheat sheet

9d13a4c

GuillaumeGomez reviewed Apr 28, 2021

View reviewed changes

JohnTitor reviewed Apr 28, 2021

View reviewed changes

Update src/rustdoc.md

2aef1db

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

jyn514 suggested changes Apr 28, 2021

View reviewed changes

Incooperate feedback

933909e

jyn514 changed the title ~~Add faster build tutorial and update cheat sheet~~ Update build instructions for rustdoc Apr 29, 2021

jyn514 added the waiting-on-author This PR is waiting for additional action by the OP label Apr 29, 2021

camelid reviewed Aug 31, 2021

View reviewed changes

src/rustdoc.md Show resolved Hide resolved

JohnTitor closed this Nov 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update build instructions for rustdoc #1117

Update build instructions for rustdoc #1117

dns2utf8 commented Apr 28, 2021

GuillaumeGomez Apr 28, 2021

jyn514 Apr 28, 2021

dns2utf8 Apr 28, 2021

jyn514 Apr 28, 2021

dns2utf8 Apr 28, 2021

jyn514 Apr 29, 2021 •

edited

GuillaumeGomez Apr 28, 2021

dns2utf8 Apr 28, 2021

jyn514 Apr 28, 2021

dns2utf8 Apr 28, 2021

JohnTitor Apr 28, 2021

dns2utf8 Apr 28, 2021

jyn514 Apr 28, 2021

dns2utf8 Apr 28, 2021

jyn514 Apr 28, 2021

dns2utf8 Apr 30, 2021

jyn514 Apr 30, 2021

jyn514 Apr 28, 2021

jyn514 Apr 28, 2021

GuillaumeGomez commented Apr 28, 2021

jyn514 commented Apr 28, 2021

dns2utf8 commented Apr 28, 2021

dns2utf8 commented Apr 28, 2021

jyn514 commented May 2, 2021

jyn514 commented Jul 3, 2021

JohnTitor commented Nov 20, 2022


		Preconfigure your `/config.toml`:

		```toml

Update build instructions for rustdoc #1117

Update build instructions for rustdoc #1117

Conversation

dns2utf8 commented Apr 28, 2021

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

jyn514 Apr 29, 2021 • edited

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

GuillaumeGomez commented Apr 28, 2021

jyn514 commented Apr 28, 2021

dns2utf8 commented Apr 28, 2021

dns2utf8 commented Apr 28, 2021

jyn514 commented May 2, 2021

jyn514 commented Jul 3, 2021

JohnTitor commented Nov 20, 2022

jyn514 Apr 29, 2021 •

edited