Following along with the Getting Started guide. I noticed that the guide specifically suggests adding the `--sccache` flag if needed, but it is included in the example invocation:
> If you installed and want to use Sccache, add --sccache to the invocation.
This means that the flag is optional and should be removed from the example invocation leaving at the user discretion to use.
The Getting Started guide offers a build-script command that new contributors can use to quickly build a debug compiler on their local machine. The command already has `--skip-tvos` and `--skip-watchos` flags since most compiler contributors don't need to build for those platforms. This change adds `--skip-xros` flag to the command.
commit bcc59744b7da00395708f41984ee2be70924cb6c
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Sat Jan 13 15:28:42 2024 +0400
applied suggested phrasing
commit b5b0f9622a5dca80cf79df41e4834959021329ca
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Fri Jan 12 23:48:12 2024 +0400
Added a note about hardware requirements for compiling on Linux
commit 863c1d98dd8c3c3e67610fe9ea9ac00e161d687a
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Fri Jan 12 23:47:19 2024 +0400
Moved note to Requirements section
commit 307d0027967945cdc5c0d28b9c4525fc27149f66
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Wed Jan 10 19:45:54 2024 +0400
Added a note about hardware requirements for compiling on Linux
commit 943ccc2726aa2f8850f38670b848304acb3359aa
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Wed Jan 10 19:45:13 2024 +0400
Replaced 'and' with 'plus' to ease comprehension
commit 3427ace37d63d398542aa80be6c30a27a940eef9
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Thu Jan 4 21:02:22 2024 +0400
Added a note about hardware requirements for compiling on Linux
commit 49bafe98a3c938e83af3de351094b47650836aee
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Thu Jan 4 20:49:35 2024 +0400
Added "of RAM" to each reference
commit 9dc879cb30e9c9507d78d5de3a1d0de2808979c6
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Thu Jan 4 14:13:20 2024 +0400
Updated text according to comment, removed mention of VM for Linux
commit b652195dcbedc7fa3a770075457880d544a78a60
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Wed Jan 3 00:06:18 2024 +0400
Added more information about different RAM requirements
commit 2aa1be00ce6ab66f50928484727e684a9eb5c243
Author: Ruslan Alikhamov <r.alikhamov@gmail.com>
Date: Mon Jan 1 03:19:22 2024 +0400
Added a note about Linux inside of a VM hardware requirements
This inline Xcode version is a maintenance bother with no apparent
justification, and shall it ever fall out of sync (like right now), it can
start causing build failures for newcomers.
We're supposed to use `${platform}` for substituting this previously defined variable. Currently used `$(platform)` will try to run a command named `platform`, which doesn't make sense.
Currently, guidance for incremental builds in `docs/GettingStarted.md` is specific to macOS and won't work on Linux. Let's adjust these steps so that they work on Linux too.
The default build variant for `--xcode` recently changed from ReleaseAssert to MinSizeRelAssert, and we forgot to update these hardcoded paths. Use asterisks to avoid having to do this again.
Given that
* we build the minimum when generating Xcode projects
* this routine need not be repeated with every Ninja build
* incremental builds are sensitive to a variety of changes
it is more foolproof to suggest a clean build up front than to tuck it away in
a list of build failure troubleshooting hints.
HowToGuides/GettingStarted: require Git 2.x
Trying to run update-checkout with Git 1.8.3.1 fails during rebasing. Git 2.38 works fine. Additionally, looks like Git 1.x requires committer name and email to be set during rebasing, which also causes errors. We should recommend Git 2.x explicitly to make sure new contributors don't get confused by this.
