Commit Graph

136 Commits

Author SHA1 Message Date
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
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
Kavon Farvardin
6f712cec4c Add tip of using dry-run flag; mention build dir setting. 2022-10-09 17:24:06 -07:00
Butta
f0dcc4839b [docs] fix formatting for GettingStarted.md and add needed flag for linux 2022-10-09 21:11:09 +05:30
Max Desiatov
04d077d353 docs: clarify sccache installation in Docker containers (#61446) 2022-10-07 09:44:57 -07:00
Max Desiatov
46a032f0d9 docs: link to Ubuntu 22.04 deps in GettingStarted.md
Currently, only a link to Ubuntu 20.04 dependencies is present. Those dependencies won't work for Ubuntu 22.04.
2022-09-29 22:58:54 +01:00
Luciano Almeida
ad76797748 Minor fixes 2022-08-05 22:54:56 -03:00
Luciano Almeida
25a7051b85 Update docs/HowToGuides/GettingStarted.md
Co-authored-by: Anthony Latsis <aqamoss3fan2010@gmail.com>
2022-08-03 09:37:09 -03:00
Luciano Almeida
abb9ee2bc0 Update docs/HowToGuides/GettingStarted.md
Co-authored-by: Anthony Latsis <aqamoss3fan2010@gmail.com>
2022-08-03 09:36:59 -03:00
Luciano Almeida
ff1b455240 Update docs/HowToGuides/GettingStarted.md
Co-authored-by: Anthony Latsis <aqamoss3fan2010@gmail.com>
2022-08-03 09:36:49 -03:00
Luciano Almeida
9a1de83fa2 [Gardening] Add troubleshooting links to getting started 2022-08-02 23:20:41 -03:00
Anthony Latsis
09a9a613c4 docs: Migrate from SR issues to GitHub issues 2022-07-14 05:10:55 +03:00
Philip Turner
393986de73 Capitalize "Intel" in GettingStarted.md 2022-06-26 15:31:29 -04:00
0x41c
156f02c8df [Docs] Add note for intel users when setting up clion 2022-06-15 14:34:17 -07:00
Michael Gottesman
234280439a [docs] Add a small howto on setting up LSP/Emacs as a C++ IDE for working on the compiler code base.
I recently helped @aprantl to set this up on their machine, so I figured I
should just add it as a HOWTO for the benefit of additional engineers.
2022-06-13 10:40:23 -07:00
Erik Eckstein
9335249e90 docs: add a reference from GettingStarted to DevelopmentTips 2022-05-23 16:12:26 +02:00