Warn about PC sleep interfering with fetch
When setting up a new Chromium repo it is important that the PC not
go to sleep in the middle of the process, since this leads to cryptic
failures. This is particularly common when configuring a new machine.
The instructions also mentioned incremental linking, but lld-link
doesn't support incremental linking, so I reworked those references.
Change-Id: I964068b5c0b97be8cd057435e85c41b130983759
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3975582
Commit-Queue: Bruce Dawson <[email protected]>
Reviewed-by: Jesse McKenna <[email protected]>
Cr-Commit-Position: refs/heads/main@{#1063471}
diff --git a/docs/windows_build_instructions.md b/docs/windows_build_instructions.md
index d46c5768..df6bc9e4 100644
--- a/docs/windows_build_instructions.md
+++ b/docs/windows_build_instructions.md
@@ -161,8 +161,15 @@
If you don't want the full repo history, you can save a lot of time by
adding the `--no-history` flag to `fetch`.
-Expect the command to take 30 minutes on even a fast connection, and many
-hours on slower ones.
+Expect the command to take over an hour on even a fast connection, and many
+hours on slower ones. You should configure your PC so that it doesn't sleep
+or hibernate during the fetch or else errors may occur. If errors occur while
+fetching sub-repos then you can start over, or you may be able to correct them
+by going to the chromium/src directory and running this command:
+
+```shell
+$ gclient sync
+```
When `fetch` completes, it will have created a hidden `.gclient` file and a
directory called `src` in the working directory. The remaining instructions
@@ -213,13 +220,13 @@
(`gn args out/Default`) or on the gn gen command line
(`gn gen out/Default --args="is_component_build = true is_debug = true"`).
Some helpful settings to consider using include:
-* `is_component_build = true` - this uses more, smaller DLLs, and incremental
-linking.
+* `is_component_build = true` - this uses more, smaller DLLs, and may avoid
+having to relink chrome.dll after every change.
* `enable_nacl = false` - this disables Native Client which is usually not
needed for local builds.
-* `target_cpu = "x86"` - x86 builds are slightly faster than x64 builds and
-support incremental linking for more targets. Note that if you set this but
-don't' set enable_nacl = false then build times may get worse.
+* `target_cpu = "x86"` - x86 builds may be slightly faster than x64 builds. Note
+that if you set this but don't set `enable_nacl = false` then build times may
+get worse.
* `blink_symbol_level = 0` - turn off source-level debugging for
blink to reduce build times, appropriate if you don't plan to debug blink.
* `v8_symbol_level = 0` - turn off source-level debugging for v8 to reduce
