Commit Graph

119 Commits

Author SHA1 Message Date
Anthony Latsis
86ff1f9626 Merge pull request #74664 from vanvoorden/patch-1 2024-06-26 18:45:39 +03:00
Mishal Shah
cfc7c86f0a Merge pull request #74724 from AnthonyLatsis/acer-palmatum
[docs] FirstPullRequest.md: Adjust for `swiftlang`
2024-06-25 23:53:04 -07:00
Anthony Latsis
dcbc51bfe6 [docs] FirstPullRequest.md: Adjust for swiftlang 2024-06-26 09:45:42 +03:00
Rick van Voorden
943b9cbe4d Update GettingStarted.md with workaround for icu error 2024-06-24 12:38:38 -07:00
Egor Zhdan
a3e3079fb6 [docs] Suggest --skip-xros in the Getting Started guide
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.
2024-06-10 16:22:36 +01:00
zane
dc3d8d1704 Fix typo in FirstPullRequest.md 2024-05-21 11:19:22 -06:00
Anthony Latsis
f1732b1eb4 [docs] FirstPullRequest: Ask people to reach out to CEW members for help on GitHub
This is easier than messaging the workgroup on the forums
2024-03-30 20:52:28 +03:00
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
4f68365467 Merge pull request #69125 from AnthonyLatsis/not-my-first-pull-request
[docs] FirstPullRequest: Update and improve sections on tidying up & code review
2023-10-13 14:21:54 +03:00
Anthony Latsis
7130132be7 [docs] FirstPullRequest: Rewrite "Tidying up" section
* Link out to FAQ for an introduction to rewriting history.
* Link out to our commit message formatting guidelines.
* Expand a bit more on what it means to tidy commit history.
2023-10-13 09:53:59 +03:00
Anthony Latsis
65d6a017f5 [docs] FirstPullRequest: Rewrite "Asking for code review" section
* Account for automatic review requests
* Add a proper fallback course of action
* Link out to commit access section on our official website
2023-10-13 09:51:21 +03:00
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
Luciano Almeida
4d99f01e9d Merge pull request #66538 from natsuk4ze/do-todo-of-faq 2023-06-14 09:35:16 -03:00
Midori
01da1cbc57 Add warnings on top 2023-06-14 11:00:55 +09:00
Midori
7b2c3d2252 Add syntax in FAQ.md 2023-06-13 12:03:21 +09:00
Midori
ff50ccacc8 Update FAQ.md
Make the text more recommended.
2023-06-13 11:59:44 +09:00
Midori
a446df35ba Update docs/HowToGuides/FAQ.md
Co-authored-by: Luciano Almeida <passos.luciano@outlook.com>
2023-06-13 00:28:56 +09:00
Midori
b46943f222 Add syntax 2023-06-11 00:11:31 +09:00
Midori
b1e58cfb05 Update FAQ.md 2023-06-10 23:38:36 +09: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
ff2bed28f1 Merge pull request #63439 from apple/AnthonyLatsis-patch-1
[docs] FAQ: Fix hardcoded arch in suggested build-script option.
2023-02-06 21:49:56 +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
Anthony Latsis
43f9869e95 [docs] FAQ: Fix hardcoded arch in suggested build-script option.
Plus a minor spelling correction and rephrasing that makes more sense.
2023-02-05 11:56:31 +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