Skip to content

Commit e51f451

Browse files
authored
Clean up documentation of unsupported legacy xcode_schemes (#3244)
the legacy xcscheme generator was removed in #3192. this can be removed from the docs without requiring breaking changes to the API. Signed-off-by: Aaron Sky <[email protected]>
1 parent 692e528 commit e51f451

File tree

4 files changed

+4
-29
lines changed

4 files changed

+4
-29
lines changed

docs/bazel.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ load("@rules_xcodeproj//xcodeproj:xcodeproj.bzl", "xcodeproj")
1919
- [`top_level_target`](#top_level_target)
2020
- [`top_level_targets`](#top_level_targets)
2121
- [`project_options`](#project_options)
22-
- [Custom Xcode schemes (Incremental generation mode)](#custom-xcode-schemes-incremental-generation-mode)
22+
- [Custom Xcode schemes](#custom-xcode-schemes)
2323
- [`xcschemes.scheme`](#xcschemes.scheme)
2424
- [`xcschemes.test`](#xcschemes.test)
2525
- [`xcschemes.run`](#xcschemes.run)
@@ -34,17 +34,6 @@ load("@rules_xcodeproj//xcodeproj:xcodeproj.bzl", "xcodeproj")
3434
- [`xcschemes.pre_post_actions.build_script`](#xcschemes.pre_post_actions.build_script)
3535
- [`xcschemes.pre_post_actions.launch_script`](#xcschemes.pre_post_actions.launch_script)
3636
- [`xcschemes.autogeneration_config`](#xcschemes.autogeneration_config)
37-
- [Custom Xcode schemes (Legacy generation mode)](#custom-xcode-schemes-legacy-generation-mode)
38-
- [`xcode_schemes.scheme`](#xcode_schemes.scheme)
39-
- [`xcode_schemes.build_action`](#xcode_schemes.build_action)
40-
- [`xcode_schemes.build_target`](#xcode_schemes.build_target)
41-
- [`xcode_schemes.build_for`](#xcode_schemes.build_for)
42-
- [`xcode_schemes.launch_action`](#xcode_schemes.launch_action)
43-
- [`xcode_schemes.profile_action`](#xcode_schemes.profile_action)
44-
- [`xcode_schemes.test_action`](#xcode_schemes.test_action)
45-
- [`xcode_schemes.diagnostics`](#xcode_schemes.diagnostics)
46-
- [`xcode_schemes.sanitizers`](#xcode_schemes.sanitizers)
47-
- [`xcode_schemes.pre_post_action`](#xcode_schemes.pre_post_action)
4837
- [Xcode build settings](#xcode-build-settings)
4938
- [`xcode_provisioning_profile`](#xcode_provisioning_profile)
5039
- [Providers](#providers)
@@ -106,7 +95,7 @@ xcodeproj(
10695
| <a id="xcodeproj-default_xcode_configuration"></a>default_xcode_configuration | Optional. The name of the the Xcode configuration to use when building, if not overridden by custom schemes.<br><br>If not set, the first Xcode configuration alphabetically will be used. Use [`xcode_configurations`](#xcodeproj-xcode_configurations) to adjust Xcode configurations. | `None` |
10796
| <a id="xcodeproj-extra_files"></a>extra_files | Optional. A `list` of extra `File`s to be added to the project. | `[]` |
10897
| <a id="xcodeproj-focused_targets"></a>focused_targets | Optional. A `list` of target labels as `string` values.<br><br>If specified, only these targets will be included in the generated project; all other targets will be excluded, as if they were listed explicitly in the `unfocused_targets` argument. The labels must match transitive dependencies of the targets specified in the `top_level_targets` argument. | `[]` |
109-
| <a id="xcodeproj-import_index_build_indexstores"></a>import_index_build_indexstores | Optional. Whether to import the index stores generated by Index Build.<br><br>This is useful if you want to use the index stores generated by Index Build to speed up Xcode's indexing process. You may not want this enabled if the additional work (mainly disk IO) of importing the index stores is not worth it for your project.<br><br>This only applies when using `generation_mode = "incremental"`. | `True` |
98+
| <a id="xcodeproj-import_index_build_indexstores"></a>import_index_build_indexstores | Optional. Whether to import the index stores generated by Index Build.<br><br>This is useful if you want to use the index stores generated by Index Build to speed up Xcode's indexing process. You may not want this enabled if the additional work (mainly disk IO) of importing the index stores is not worth it for your project. | `True` |
11099
| <a id="xcodeproj-install_directory"></a>install_directory | Optional. The directory where the generated project will be written to.<br><br>The path is relative to the workspace root.<br><br>Defaults to the directory that the `xcodeproj` target is declared in (e.g. if the `xcodeproj` target is declared in `//foo/bar:BUILD` then the default value is `"foo/bar"`). Use `""` to have the project generated in the workspace root. | `None` |
111100
| <a id="xcodeproj-ios_device_cpus"></a>ios_device_cpus | Optional. The value to use for `--ios_multi_cpus` when building the transitive dependencies of the targets specified in the `top_level_targets` argument with the `"device"` `target_environment`.<br><br>**Warning:** Changing this value will affect the Starlark transition hash of all transitive dependencies of the targets specified in the `top_level_targets` argument with the `"device"` `target_environment`, even if they aren't iOS targets. | `"arm64"` |
112101
| <a id="xcodeproj-ios_simulator_cpus"></a>ios_simulator_cpus | Optional. The value to use for `--ios_multi_cpus` when building the transitive dependencies of the targets specified in the `top_level_targets` argument with the `"simulator"` `target_environment`.<br><br>If no value is specified, it defaults to the simulator cpu that goes with `--host_cpu` (i.e. `sim_arm64` on Apple Silicon and `x86_64` on Intel).<br><br>**Warning:** Changing this value will affect the Starlark transition hash of all transitive dependencies of the targets specified in the `top_level_targets` argument with the `"simulator"` `target_environment`, even if they aren't iOS targets. | `None` |

xcodeproj/internal/dependencies.bzl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
"""Module for collecting dependencies. Only to be used when \
2-
`xcodeproj.generation_mode = "incremental"` is set."""
1+
"""Module for collecting dependencies."""
32

43
load(":memory_efficiency.bzl", "memory_efficient_depset")
54

xcodeproj/internal/docs/bazel.header.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ load("@rules_xcodeproj//xcodeproj:xcodeproj.bzl", "xcodeproj")
1919
- [`top_level_target`](#top_level_target)
2020
- [`top_level_targets`](#top_level_targets)
2121
- [`project_options`](#project_options)
22-
- [Custom Xcode schemes (Incremental generation mode)](#custom-xcode-schemes-incremental-generation-mode)
22+
- [Custom Xcode schemes](#custom-xcode-schemes)
2323
- [`xcschemes.scheme`](#xcschemes.scheme)
2424
- [`xcschemes.test`](#xcschemes.test)
2525
- [`xcschemes.run`](#xcschemes.run)
@@ -34,17 +34,6 @@ load("@rules_xcodeproj//xcodeproj:xcodeproj.bzl", "xcodeproj")
3434
- [`xcschemes.pre_post_actions.build_script`](#xcschemes.pre_post_actions.build_script)
3535
- [`xcschemes.pre_post_actions.launch_script`](#xcschemes.pre_post_actions.launch_script)
3636
- [`xcschemes.autogeneration_config`](#xcschemes.autogeneration_config)
37-
- [Custom Xcode schemes (Legacy generation mode)](#custom-xcode-schemes-legacy-generation-mode)
38-
- [`xcode_schemes.scheme`](#xcode_schemes.scheme)
39-
- [`xcode_schemes.build_action`](#xcode_schemes.build_action)
40-
- [`xcode_schemes.build_target`](#xcode_schemes.build_target)
41-
- [`xcode_schemes.build_for`](#xcode_schemes.build_for)
42-
- [`xcode_schemes.launch_action`](#xcode_schemes.launch_action)
43-
- [`xcode_schemes.profile_action`](#xcode_schemes.profile_action)
44-
- [`xcode_schemes.test_action`](#xcode_schemes.test_action)
45-
- [`xcode_schemes.diagnostics`](#xcode_schemes.diagnostics)
46-
- [`xcode_schemes.sanitizers`](#xcode_schemes.sanitizers)
47-
- [`xcode_schemes.pre_post_action`](#xcode_schemes.pre_post_action)
4837
- [Xcode build settings](#xcode-build-settings)
4938
- [`xcode_provisioning_profile`](#xcode_provisioning_profile)
5039
- [Providers](#providers)

xcodeproj/xcodeproj.bzl

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,6 @@ def xcodeproj(
156156
Index Build to speed up Xcode's indexing process. You may not want
157157
this enabled if the additional work (mainly disk IO) of importing
158158
the index stores is not worth it for your project.
159-
160-
This only applies when using `generation_mode = "incremental"`.
161159
install_directory: Optional. The directory where the generated project
162160
will be written to.
163161

0 commit comments

Comments
 (0)