Removed old localPackages things from Documents

This commit is contained in:
freddi 2020-03-19 23:45:21 +09:00
parent 6bbd90ce4b
commit 5c380bf917
2 changed files with 1 additions and 40 deletions

View File

@ -25,7 +25,6 @@
- [Scheme](#scheme)
- [Scheme Template](#scheme-template)
- [Swift Package](#swift-package)
- [Local Swift Package](#local-swift-package)
## General
@ -50,7 +49,6 @@ You can also use environment variables in your configuration file, by using `${S
- [ ] **schemes**: **[Scheme](#scheme)** - A list of schemes by name. This allows more control over what is found in [Target Scheme](#target-scheme)
- [ ] **targetTemplates**: **[String: [Target Template](#target-template)]** - a list of targets that can be used as templates for actual targets which reference them via a `template` property. They can be used to extract common target settings. Works great in combination with `include`.
- [ ] **packages**: **[String: [Swift Package](#swift-package)]** - a map of Swift packages by name. The paths must be directories with a `Package.swift` file if specified as local package by `path`.
- [ ] **localPackages**: **[String: [Local Swift Package](#local-swift-package)]** - a map of local Swift packages by name. This is same with local package at **packages** by `path`. The paths must be directories with a `Package.swift` file in them. If same name remote repo is listed in `packages`, the repo will be overridden to a package in `localPackages` for development purposes.
- [ ] **projectReferences**: **[String: [Project Reference](#project-reference)]** - a map of project references by name
### Include
@ -906,24 +904,6 @@ targets:
- package: RxClient
```
## Local Swift Package
Swift packages in local are also defined at a project level as `localPackages` like `packages` , and then linked to individual targets via a [Dependency](#dependency).
> Note that Swift Packages don't work in projects with configurations other than `Debug` and `Release`. That limitation is tracked here bugs.swift.org/browse/SR-10927
- [x] **path**: **String** - the path to the package in local
```yml
localPackages:
RxClient:
path: Packages/RxClient
targets:
App:
dependencies:
- package: RxClient
```
## Project Reference
Project References are defined at a project level, and then you can use the project name to refer its target via a [Scheme](#scheme)

View File

@ -181,26 +181,7 @@ If you want to check in the `Package.resolved` file so that everyone is on the s
> Note that Swift Packages don't work in projects with configurations other than `Debug` and `Release`. That limitation is tracked here bugs.swift.org/browse/SR-10927
You can also include local Swift Packages by referencing them by paths in `localPackages` and you can use them as `dependencies` same with `packages`. When these local packages in `localPackages` have the same name as remote repos in `packages`, they will be used instead of the remote repos. This is useful for local development.
```yml
packages:
Yams:
url: https://github.com/jpsim/Yams
from: 2.0.0
localPackages:
MyPackage:
path: Package/MyPackage
Yams:
path: ../Yams
targets:
App:
dependencies:
- package: MyPackage
- package: Yams # Yams in local will be used instead of Yams from remote repos
```
These local packages get put into a `Packages` group in the root of the project by default. This can be changed with `options.localPackagesGroup`.
Specified local packages get put into a `Packages` group in the root of the project by default. This can be changed with `options.localPackagesGroup`.
### SDK
System frameworks and libs can be linked by using the `sdk` dependency type. You can either specify frameworks or libs by using a `.framework`, `.tbd` or `dylib` filename, respectively