Commit Graph

138 Commits

Author SHA1 Message Date
Max Desiatov
ede49497d5 GettingStarted.md: avoid preinstalling CMake (#83063)
We're seeing multiple build failures with CMake 4.0: e.g. SwiftPM bootstrapping issues  on macOS. `build-script` will always build a fixed version of CMake that's known to work if preinstalled one is not found. Let's reduce the chances for confusion by not recommending preinstalled CMake in `GettingStarted.md`.
2025-07-17 17:04:19 +01:00
Ziad Ashraf
a9fb63a586 [docs] Add the Ubuntu 24.04 Dockerfile link to the getting started guide 2025-04-13 23:51:20 +02:00
Konrad `ktoso` Malawski
6e725f277d Update CLion instructions (#79900)
We use the `RelWithDebInfo` configuration nowadays, so correct the instructions.
2025-03-10 22:27:03 -07:00
John Hui
cc8c5bb01e [doc] Fix typo in shell command from Getting Started guide (#77634) 2024-11-15 00:42:01 -08:00
Hamish Knight
03d8ea5248 Introduce swift-xcodegen
This is a tool specifically designed to generate
Xcode projects for the Swift repo (as well as a
couple of adjacent repos such as LLVM and Clang).
It aims to provide a much more user-friendly experience
than the CMake Xcode generation (`build-script --xcode`).
2024-11-05 22:42:10 +00:00
Anthony Latsis
54ef4dc67a [docs] FirstPullRequest: Turn CEWG team handle into a link (#76866)
GitHub handles do not work automatically in files.
2024-10-04 07:59:16 -07:00
Anthony Latsis
09c73585ca docs: Update links to section on commit access (#76672)
This section has migrated to our local contributing file and will soon
be removed from the website.
2024-09-24 10:46:03 -07:00
Anthony Latsis
9e752ca473 docs: Update link to commit message guidelines (#76667)
This information is specific to the compiler repository and now lives in our local contributing page.
2024-09-24 05:55:24 -07:00
Ellis Hoag
20bca94b6f [docs] Fix links to dockerfiles
It seems that the `master/` directory in these paths have been renamed to `main`.
2024-09-06 15:58:26 -07:00
LamTrinh.Dev
2cd4b6973a Update wording from commandline to command line (#76121) 2024-08-28 08:39:01 -07:00
Matt Massicotte
721f5290e4 [docs] NFC: Remove redundant --sccache flag (#75390)
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.
2024-07-24 00:53:38 -07:00
LamTrinh.Dev
b6239b8cee [docs] Update links to repositories moved to https://github.com/swiftlang/ 2024-07-22 12:22:43 -07:00
Anthony Latsis
5b5244f4d0 Merge pull request #75231 from AnthonyLatsis/coryphaena-hippurus
[NFC] GettingStarted: Several straightforward improvements
2024-07-18 07:03:00 +03:00
Jeremy Schonfeld
f3acbb079f Remove ICU from the toolchain (#75262)
* Remove ICU from the toolchain

* Remove icu comment from GettingStarted.md
2024-07-17 18:19:16 -07:00
Anthony Latsis
1921b60ff4 [NFC] GettingStarted: Remove --skip-<os> flags from build script command
These flags are dead weight because the options they disable default to
false.
2024-07-13 18:57:46 -07:00
Anthony Latsis
688f0f4e08 [NFC] GettingStarted: Use new GitHub alert syntax
But only for top-level alerts. Nested alerts will not render. See
https://github.com/orgs/community/discussions/16925#discussioncomment-9538837.
2024-07-14 04:35:08 +03:00
Anthony Latsis
53f0a7fe2e [NFC] GettingStarted: Minor corrections & clarifications for Ninja with Xcode 2024-07-14 04:35:05 +03:00
Anthony Latsis
a864b9c241 [NFC] GettingStarted: Replace list of forum topics with search link for troubleshooting
Take advantage of the tags that we attach to such topics. Also tune
the GitHub issues link by analogy.
2024-07-14 04:25:50 +03:00
Vidhu Panhavoor Vasudevan
f7bafb3548 Update Repository name in GettingStarted.md
The name of the swift repository has changed from apple/swift to swiftlang/swift
2024-07-10 21:22:56 -04:00
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