Skip to content

Commit 53f0a7f

Browse files
committed
[NFC] GettingStarted: Minor corrections & clarifications for Ninja with Xcode
1 parent a864b9c commit 53f0a7f

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ following steps assume that you have already [built the toolchain with Ninja](#t
365365

366366
> **Note**
367367
> A seamless LLDB debugging experience requires that your `build-script`
368-
invocation for Ninja is tuned to produce build rules for the
368+
invocation for Ninja is tuned to generate build rules for the
369369
[debug variant](#debugging-issues) of the component you intend to debug.
370370

371371
* <p id="generate-xcode">
@@ -378,21 +378,26 @@ following steps assume that you have already [built the toolchain with Ninja](#t
378378
This can take a few minutes due to metaprogrammed sources that depend on LLVM
379379
tools that are built from source.
380380
</p>
381-
* Create an empty Xcode workspace.
382-
* Add `build/Xcode-*/swift-macosx-*/Swift.xcodeproj` to the workspace. If Xcode
383-
prompts to autocreate schemes, select *Manually Manage Schemes* and don't
384-
create any schemes just yet.
385-
386-
This project includes the sources for almost everything in the repository,
387-
including the compiler, standard library and runtime. If you intend to work on
388-
a compiler subcomponent that is written in Swift and has a `Package.swift`
389-
file (e.g. `lib/ASTGen`), first choose *Product > Scheme > Manage Schemes...*
390-
and select the *Autocreate schemes* checkbox, then add the package directory
391-
to the workspace by choosing *File > Add Files to "\<workspace name>"*. Xcode
392-
will automatically create schemes for package manifest.
381+
* Create an empty Xcode workspace and open it.
382+
* Add `build/Xcode-*/swift-macosx-*/Swift.xcodeproj` to the workspace by
383+
selecting the Project navigator and choosing
384+
*File > Add Files to "\<workspace name>"*.
385+
386+
> **Important**\
387+
> If upon addition Xcode prompts to autocreate schemes, select *Manually
388+
Manage Schemes*.
389+
390+
This Xcode project includes the sources for almost everything in the
391+
repository, including the compiler, standard library and runtime.
392+
If you intend to work on a compiler subcomponent that is written in Swift and
393+
has a `Package.swift` file, e.g. `lib/ASTGen`, first choose
394+
*Product > Scheme > Manage Schemes* and select the *Autocreate schemes*
395+
checkbox, then add the package directory to the workspace the same way you
396+
added the Xcode project.
397+
Xcode will automatically create schemes for the package manifest.
393398
* Create an Xcode project using the _External Build System_ template, and add
394399
it to the workspace.
395-
* Create a target in the new project, using the _External Build System_
400+
* Create a target in the new Xcode project, using the _External Build System_
396401
template.
397402
* In the _Info_ pane of the target settings, set
398403
* _Build Tool_ to the absolute path of the `ninja` executable (the output of

0 commit comments

Comments
 (0)