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
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