rename includeCarthageRelatedDependencies to findCarthageFrameworks and includeRelated to findFrameworks

This commit is contained in:
yonaskolb
2019-03-24 22:59:29 +11:00
parent 5accd0e095
commit bcbc83dd75
12 changed files with 43 additions and 43 deletions
+3 -3
View File
@@ -111,7 +111,7 @@ Note that target names can also be changed by adding a `name` property to a targ
- `bottom` (default) - at the bottom, after other files
- [ ] **transitivelyLinkDependencies**: **Bool** - If this is `true` then targets will link to the dependencies of their target dependencies. If a target should embed its dependencies, such as application and test bundles, it will embed these transitive dependencies as well. Some complex setups might want to set this to `false` and explicitly specify dependencies at every level. Targets can override this with [Target](#target).transitivelyLinkDependencies. Defaults to `false`.
- [ ] **generateEmptyDirectories**: **Bool** - If this is `true` then empty directories will be added to project too else will be missed. Defaults to `false`.
- [ ] **includeCarthageRelatedDependencies**: **Bool** - When this is set to `true`, any carthage dependency with related dependencies will be included automatically. This flag can be overriden individually for each carthage dependency - for more details see See **includeRelated** in the [Dependency](#dependency) section. Defaults to `false`.
- [ ] **findCarthageFrameworks**: **Bool** - When this is set to `true`, any carthage dependency with related dependencies will be included automatically. This flag can be overriden individually for each carthage dependency - for more details see See **findFrameworks** in the [Dependency](#dependency) section. Defaults to `false`.
```yaml
options:
@@ -383,7 +383,7 @@ Carthage frameworks are expected to be in `CARTHAGE_BUILD_PATH/PLATFORM/FRAMEWOR
- `PLATFORM` = the target's platform
- `FRAMEWORK` = the specified name.
If any of the Carthage dependencies has related dependencies, they can be automatically included using the `includeRelated: true` flag.
If any of the Carthage dependencies has related dependencies, they can be automatically included using the `findFrameworks: true` flag.
Xcodegen uses `.version` files generated by Carthage so in order for this to work the dependencies will need to be built / available in the specified Carthage build folder.
If any applications contain carthage dependencies within itself or any dependent targets, a carthage copy files script is automatically added to the application containing all the relevant frameworks. A `FRAMEWORK_SEARCH_PATHS` setting is also automatically added
@@ -395,7 +395,7 @@ targets:
- target: MyFramework
- framework: path/to/framework.framework
- carthage: Result
includeRelated: true
findFrameworks: true
- sdk: Contacts.framework
- sdk: libc++.tbd
MyFramework: