Commit Graph

107 Commits

Author SHA1 Message Date
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
Erik Eckstein
9335249e90 docs: add a reference from GettingStarted to DevelopmentTips 2022-05-23 16:12:26 +02:00
Luciano Almeida
efdf354a29 [Docs] Updating Getting started documentation from JIRA to Swift Issues 2022-05-11 22:17:47 -03:00
Alex Hoppen
29639f17e5 Merge pull request #40873 from philipturner/patch-5 2022-05-09 11:19:14 +02:00
Egor Zhdan
93ce94a05f [Docs] Remove dead link to CentOS 8 Dockerfile
CentOS 8 is no longer supported after https://github.com/apple/swift-docker/pull/273
2022-04-13 14:57:24 +01:00
Konrad `ktoso` Malawski
fe539399d1 Update GettingStarted.md 2022-04-05 13:18:53 +09:00
Konrad `ktoso` Malawski
8775359704 Apply suggestions from code review
Co-authored-by: buttaface <repo@butta.fastem.com>
2022-04-05 11:47:20 +09:00
Konrad `ktoso` Malawski
92acc18a7d Minor update to clion guide 2022-04-05 10:22:56 +09:00
Konrad `ktoso` Malawski
c5bd201e41 [Guide] Add guide to set up CLion for compiler development 2022-04-05 10:21:23 +09:00
Philip Turner
eed852b8cb Sccache bug has been fixed 2022-01-16 10:55:16 -05:00
Philip Turner
0aabc0c400 Fix typo in GettingStarted.md 2022-01-16 08:51:01 -05:00
Boris Bügling
3053e6de67 Fix TOC entry for Linux in GettingStarted
The TOC was referencing a no longer existing "Ubuntu Linux" section.
2021-09-13 15:49:04 -07:00
Mishal Shah
9024f951c9 Update the Xcode version to Xcode 13 beta 4 2021-08-25 17:15:44 -07:00
zoecarver
a13c57c360 Bump CMake version to 3.19.6.
Updates the CMake version for Swift and the Swift Benchmarks to 3.19.6.
Updates the docs to reflect this change. Does not modify the required version for building the stdlib.
2021-07-12 08:57:35 -07:00
Mishal Shah
843739f926 Update the Linux dependencies (#38170) 2021-07-05 23:30:23 -07:00
Butta
c673023f94 [docs] Add basic build-script command for Linux and corelibs flag 2021-06-24 04:30:57 +05:30
Alex Hoppen
987415283f [docs] Add warning that sccache isn't caching any commands since version 0.2.14 2021-02-08 09:33:09 +01:00
Varun Gandhi
36b589d623 Merge pull request #35538 from mininny/disable-dead-stripping-option
[build-script] Add swift-disable-dead-stripping option for disabling dead stripping
2021-01-31 16:31:48 -08:00
Brentley Jones
bf6c753a81 Update guide to mention correct subdirectory
The guide as written results in lots of repositories being placed as siblings to `swift-project`, instead of inside of it. This also results in the `build` directory being a sibling. Changing the clone to the `swift` directory fixes this.
2021-01-22 11:08:51 -06:00
Minhyuk Kim
b0426829fe Add swift_disable_dead_stripping option for disabling dead stripping in Swift build 2021-01-22 23:56:02 +09:00
Dave Abrahams
565385b6b0 Stop creating swift-project/swift/swift
The instructions as written will create an unnecessary swift/swift directory, it looks like.
2021-01-06 14:49:46 -08:00
Max Desiatov
52d9398c30 Merge pull request #34998 from apple/maxd/fix-apple-silicon
CMake: fix build for Apple Silicon hosts

When building with `build-script` using these arguments

```
utils/build-script --skip-build-benchmarks
  --skip-ios --skip-watchos --skip-tvos
  --swift-darwin-supported-archs "arm64"
  --sccache --release-debuginfo --test
```

the build fails with

```
ninja: error: 'stdlib/swift-test-stdlib-macosx-x86_64',
needed by 'stdlib/CMakeFiles/swift-test-stdlib', missing and no known rule to make it
```

I think that the "Getting Started" guide should avoid hardcoding `x86_64` arguments, and suggest using `$(uname -m)` instead. `SWIFT_PRIMARY_VARIANT_ARCH_default` could also get its value from `CMAKE_HOST_SYSTEM_PROCESSOR` in the root `CMakeLists.txt`.

Resolves SR-13943.
2021-01-06 18:05:28 +00:00
Mishal Shah
212acff1e1 Update the Xcode version to Xcode 12.3 GM 2020-12-22 01:54:57 -08:00
Alex Reilly
3b80719ea2 Add -b flag to checkout
I think this is necessary to create a new branch
2020-12-16 22:27:59 -08:00