Commit Graph

92 Commits

Author SHA1 Message Date
Anthony Latsis
5dac5e2f79 Merge pull request #70658 from art-divin/improve-getting-started-linux-vm
Add a note about hardware requirements for compiling on Linux
2024-02-14 00:29:13 +03:00
Anthony Latsis
cb988a4899 [docs] GettingStarted: Restructure "The actual build" section 2024-01-26 01:39:15 +03:00
Anthony Latsis
bed316f4cc [docs] GettingStarted: Default to "hosttools" bootstrapping mode on macOS 2024-01-19 20:53:31 +03:00
Ruslan Alikhamov
fd3557bf5a Added a note about RAM and disk space hardware requirements
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
2024-01-13 15:29:27 +04:00
Finagolfin
22e1ed3acd [docs] GettingStarted: Update the linux instructions to use a prebuilt Swift compiler 2023-12-12 08:02:39 +05:30
Anthony Latsis
83fabf157e Merge pull request #68863 from AnthonyLatsis/xcode-version-redirect
[docs] GettingStarted: Send readers to ci.swift.org for the min Xcode version
2023-09-30 05:26:04 +03:00
Anthony Latsis
e52589f175 [docs] GettingStarted: Send readers to ci.swift.org for the min Xcode version
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.
2023-09-29 23:45:39 +03:00
Anthony Latsis
3072918206 [docs] GettingStarted: Fix a typo 2023-09-21 12:36:16 +03:00
Anthony Latsis
41c473ff09 [docs] GettingStarted: Misc improvements to the Xcode setup instructions 2023-09-19 20:18:22 +03:00
Nick Randall
46ed883617 Update GettingStarted with note on M1 Macs 2023-08-06 13:26:13 +02:00
Kavon Farvardin
dade95dcc0 make python 3.6 the official minimum version 2023-07-25 10:33:21 -07:00
Max Desiatov
f61249d34e GettingStarted.md: fix incorrect list item index 2023-06-20 10:05:32 +01:00
Max Desiatov
3a0802b26f GettingStarted.md: add missing link for Ubuntu 18.04 dependencies 2023-06-20 10:04:23 +01:00
Sima Nerush
fdb00bea6d [docs] GettingStarted: Add a warning about spaces in the absolute path 2023-06-08 13:20:55 -07:00
Max Desiatov
d7272069ff docs: Fix shell var substitution in GettingStarted.md (#65803)
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.
2023-05-09 21:13:03 +01:00
Max Desiatov
2e879729ba docs/GettingStarted.md: support Linux in incremental build steps (#65653)
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.
2023-05-05 13:45:20 +01:00
Anthony Latsis
ea1d0a3a3a Merge pull request #63541 from apple/AnthonyLatsis-patch-2 2023-02-11 17:15:19 +03:00
Anthony Latsis
a7517b0b39 [docs] GettingStarted: Tweak one more Ninja target suggestion to work on Apple Silicon
See https://github.com/apple/swift/issues/62017
2023-02-11 04:21:19 +03:00
Anthony Latsis
60bf5447ad [docs] GettingStarted: Bump required CMake version for --xcode once more
2.24.2 is the oldest version that didn't reproduce the code signing issue from 
https://github.com/apple/swift/issues/62023 with the latest Xcode release (14.2).
2023-02-06 22:40:57 +03:00
Anthony Latsis
70a1f9f156 Merge pull request #63451 from apple/AnthonyLatsis-patch-2
[docs] GettingStarted: Replace build variant suffix with asterisks in paths to `--xcode` build artifacts
2023-02-06 21:50:59 +03:00
Anthony Latsis
fed05f6cb9 [docs] GettingStarted: Remove outdated assumption
The guide is no longer dependent on the architecture.
2023-02-06 14:45:43 +03:00
Anthony Latsis
a2cb93eccb [docs] GettingStarted: Replace build variant suffix with asterisks in paths to --xcode build artifacts
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.
2023-02-06 14:16:17 +03:00
Anthony Latsis
a8c5f45da5 [docs] Suggest ninja bin/swift-frontend instead of ninja swift-frontend
...to cope with a bootstrapping quirk on arm64 Macs.
2023-02-06 13:09:28 +03:00
Erik Eckstein
ef11448533 docs: fix info about bootstrapping
https://github.com/apple/swift/issues/62017
2023-02-02 16:55:21 +01:00
Anthony Latsis
4409c2fc6c Merge pull request #63271 from AnthonyLatsis/min-size-xcode
build: Override default build variant for `--xcode`
2023-02-01 04:18:19 +03:00
Anthony Latsis
3f4f4ffafa build: Override default build variant for --xcode 2023-01-28 01:29:53 +03:00
Holly Borla
fcfd08920f Merge pull request #63082 from AnthonyLatsis/good-first-issues
docs: Supplant the "starter bug" term by "good first issue"
2023-01-26 08:11:21 -08:00
Anthony Latsis
a445516615 docs: Supplant the "stater bug" term by "good first issue" 2023-01-25 19:06:10 +03:00
Adam Newton
de41784d41 Bump cmake version in GettingStarted.md
Co-authored-by: Anthony Latsis <aqamoss3fan2010@gmail.com>
2023-01-18 17:24:11 -08:00
Anthony Latsis
4e5b55e0af Merge pull request #62558 from AnthonyLatsis/wakamole2
[docs] GettingStarted.md: Minor fixes and improvements
2022-12-15 23:50:28 +03:00
Anthony Latsis
bb4d9dbd39 [docs] GettingStarted.md: Fix typo in path 2022-12-13 21:00:01 +03:00
Anthony Latsis
7e84f547ea [docs] GettingStarted.md: Do not suggest incremental builds for generating Xcode projects
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.
2022-12-13 20:38:29 +03:00
Anthony Latsis
86d3220d07 Merge pull request #62371 from AnthonyLatsis/wakamole
GettingStarted.md: A sprinkle of minor improvements
2022-12-08 09:44:28 +03:00
Anthony Latsis
52c821a76c GettingStarted.md: Reformat notes 2022-12-08 06:48:31 +03:00
Anthony Latsis
c7ca36186a GettingStarted.md: Fix indentation in bullet so that it renders correctly 2022-12-08 06:48:31 +03:00
Anthony Latsis
3cfb3b8346 GettingStarted.md: Don’t suggest starting Sccache manually: build-script does it for you 2022-12-08 06:48:16 +03:00
Max Desiatov
e0a12d1f93 Merge pull request #62055 from apple/maxd/git-started
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.
2022-11-30 16:16:47 +00:00
Konrad `ktoso` Malawski
bf03c71890 Fix CLion getting started, swift-syntax is also required now
Also include the swift-syntax path, otherwise CMake import in CLion will fail.
2022-11-26 12:16:24 +09:00
Anthony Latsis
8bf1c3d3f2 [docs] GettingStarted.md: Recommend building the --release variant of --xcode
The `--release` variant takes up 4 times less space than the default `--debug`
variant (0.45GB vs 1.8GB).
2022-11-17 09:54:02 +03:00
Max Desiatov
cac003b944 GettingStarted.md: refine wording for the Git version requirement 2022-11-13 17:10:15 +00:00
Luciano Almeida
da4bea88cc [Docs] Add note about debugging with --release-debuginfo build-script flag (#62048) 2022-11-13 07:58:58 -03:00
Max Desiatov
dabecb5929 HowToGuides/GettingStarted: require Git 2.x
Trying to run `update-checkout` with Git 1.8.3.1 fails during rebasing.
2022-11-12 11:38:56 +00:00
Anthony Latsis
b5400ed9e5 [docs] GettingStarted.md: Minor amendments to instructions for setting up an Xcode workflow
* When an input path must be absolute, emphasize it.
* Get around an unnecessary placeholder in a path.
2022-11-10 07:52:42 +03:00
Anthony Latsis
e47444f153 [docs] GettingStarted.md: Warn about bootstrapping bug on Macs with arm64 chips
Also, suggest opting out of bootstrapping when appropriate.
2022-11-10 04:52:38 +03:00
Anthony Latsis
98ced88a32 [docs] GettingStarted.md: Make integration with Ninja the recommended Xcode workflow
...now that the build-script `--xcode` option implies `--skip-build`.
2022-11-06 03:36:24 +03:00
Anthony Latsis
c0abe0baf2 Merge pull request #61713 from AnthonyLatsis/ninja-with-xcode
[docs] Improve instructions for using Ninja with Xcode & move them to GettingStarted.md
2022-11-01 22:19:28 +03:00
Anthony Latsis
712dc7b882 [docs] GettingStarted.md: Remove dual Ninja-Xcode workflow description
We deprecate this option in favor of integrating a Ninja build with Xcode
2022-10-27 07:21:12 +03:00
Anthony Latsis
7c84923239 [docs] Move instructions for using Ninja with Xcode to GettingStarted.md 2022-10-27 07:21:12 +03:00
Anthony Latsis
d64def279d [docs] GettingStarted.md: Do not suggest to run tests when building toolchain
* Running the entire test suite is unnecessarily burdensome for newcomers, given
  the already considerable build times.
* Test failures are not a beginner-friendly indication of an out-of-sync
  checkout, nor is such an indication generally worth the expenses.
* We do not want a known issue to block anyone’s workflow.
2022-10-19 21:51:02 +03:00
swift-ci
f9d7ac715b Merge pull request #61511 from buttaface/doc
[docs] fix formatting for GettingStarted.md and add needed flag for linux
2022-10-10 09:55:38 -07:00