Commit Graph

138 Commits

Author SHA1 Message Date
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
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
Hassan ElDesouky
27a11bd4a3 [Docs] Correct the link to the CODE_OWNERS.TXT 2021-03-22 17:12:08 +02:00
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
Ben Rimmington
020b02af82 Update links to the Code of Conduct (#35128)
* Update README.md
* Update FirstPullRequest.md
2020-12-17 01:17:09 +00:00
Max Desiatov
0b86753236 CMake: fix builds for Apple Silicon hosts 2020-12-08 14:30:47 +00:00
Mishal Shah
bd6cc586d5 Update the Xcode version in Getting Started doc 2020-10-16 14:42:42 -07:00
Mishal Shah
23cde90b29 Update the Xcode version in How to Guides 2020-10-16 14:41:14 -07:00
Mishal Shah
00501fcaab Update GettingStarted doc to use --scheme for update-checkout script
https://bugs.swift.org/browse/SR-13717
2020-10-09 16:05:37 -07:00
Cassie Jones
e01893cb56 [build-script] Add a flag for sccache
This adds a flag to enable sccache in order to simplify the build-script
invocation, particularly for new contributors.
2020-09-30 16:49:34 -04:00
Mishal Shah
40024718ac Update doc and links to support new main branch 2020-09-22 23:53:29 -07:00
Varun Gandhi
23b65ede3b [docs] Properly reflect diversity in Swift programmers in emoji. 2020-09-10 13:22:21 -07:00
Varun Gandhi
b6558fd9ed [docs] Describe using git grep in FAQ.
Also changed the grep example to use long flag names for clarity.
2020-09-09 13:42:31 -07:00
Varun Gandhi
58fcc4602d [docs] Fix typos and broken links. 2020-09-09 13:41:48 -07:00
Varun Gandhi
ae8db93dd0 [docs] Revise documentation building instructions and move to FAQ.md. 2020-09-08 20:28:11 -07:00
Varun Gandhi
3fe3500d98 [docs] Add First Pull Request guide and Getting Started guide.
This improves upon the existing documentation to provide a clearer end-to-end
workflow for new contributors and people who wish to build the toolchain
locally but do not intend to submit patches.

We also provide more directions for systematically utilizing our existing
documentation.
2020-09-08 20:28:11 -07:00
Varun Gandhi
67791cceac [docs] Add a how-to guide on running IWYU on the Swift project. (#32151) 2020-06-04 14:40:05 -07:00