From 9e657eeb8738e23fe483dcf22d8ff15d70141f6a Mon Sep 17 00:00:00 2001 From: Hamish Knight Date: Wed, 6 Nov 2024 20:24:34 +0000 Subject: [PATCH] [xcodegen] Update README Make it a bit clearer that `utils/generate-xcode` is a convenience for the `swift-xcodegen` script in this directory. --- utils/swift-xcodegen/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/utils/swift-xcodegen/README.md b/utils/swift-xcodegen/README.md index 1cd4ab8cd0e4f..ab42003d1a133 100644 --- a/utils/swift-xcodegen/README.md +++ b/utils/swift-xcodegen/README.md @@ -11,13 +11,15 @@ This script is primarily focussed on providing a good editor experience for work ## Running -Run as: +You can run using either `utils/generate-xcode` or the `swift-xcodegen` script in this directory; the former is just a convenience for the latter. The basic invocation is: +```sh +./swift-xcodegen ``` -./swift-xcodegen -``` -An Xcode project will be created in the grandparent directory (i.e `build/../Swift.xcodeproj`). Projects for LLVM, LLDB, and Clang may also be created by passing `--llvm`, `--lldb`, and `--clang` respectively. Workspaces of useful combinations will also be created (e.g Swift+LLVM, Clang+LLVM). +where `` is the path to the build directory e.g `build/Ninja-RelWithDebInfoAssert`. This will by default create a `Swift.xcodeproj` in the parent directory (next to the `build` directory). Projects for LLVM, LLDB, and Clang may also be created by passing `--llvm`, `--lldb`, and `--clang` respectively. Workspaces of useful combinations will also be created (e.g Swift+LLVM, Clang+LLVM). + +For the full set of options, see the [Command usage](#command-usage) below. An `ALL` meta-target is created that depends on all the targets in the given project or workspace. A scheme for this target is automatically generated too (and automatic scheme generation is disabled). You can manually add individual schemes for targets you're interested in. Note however that Clang targets do not currently have dependency information.