Skip to content

Commit 7ea3ded

Browse files
committed
docs update
1 parent 71c328a commit 7ea3ded

4 files changed

Lines changed: 10 additions & 9 deletions

File tree

apple/apple_archive.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2025 The Bazel Authors. All rights reserved.
1+
# Copyright 2026 The Bazel Authors. All rights reserved.
22
#
33
# Licensed under the Apache License, Version 2.0 (the "License");
44
# you may not use this file except in compliance with the License.

apple/internal/apple_archive.bzl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -441,10 +441,10 @@ The label to a target to re-package into an Apple archive. For example, an
441441
"include_symbols": attr.bool(
442442
default = False,
443443
doc = """
444-
If true, collects `$UUID.symbols`
445-
files from all `{binary: .dSYM, ...}` pairs for the application and its
446-
dependencies, then packages them under the `Symbols/` directory in the
447-
final archive.
444+
If true, collects generated `$UUID.symbols` files from all `{binary: .dSYM, ...}`
445+
pairs for the application and its dependencies, then packages them under the
446+
`Symbols/` directory in the final archive. Symbol files are only available when
447+
dSYM generation is enabled, such as by passing `--apple_generate_dsym`.
448448
""",
449449
),
450450
},
@@ -464,7 +464,7 @@ target's unarchived bundle root for IDE consumers.
464464
Example:
465465
466466
````starlark
467-
load("//apple:apple_archive.bzl", "apple_archive")
467+
load("@rules_apple//apple:apple_archive.bzl", "apple_archive")
468468
469469
ios_application(
470470
name = "App",

doc/common_info.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,14 +557,15 @@ When using Bazel's remote cache and/or build execution, there are a few flags yo
557557
We recommend adding the following to your `.bazelrc`:
558558

559559
```shell
560-
common --modify_execution_info=^(BundleApp|BundleTreeApp|DsymDwarf|DsymLipo|GenerateAppleSymbolsFile|ObjcBinarySymbolStrip|CppArchive|CppLink|ObjcLink|ProcessAndSign|SignBinary|SwiftArchive|SwiftStdlibCopy)$=+no-remote,^(BundleResources|ImportedDynamicFrameworkProcessor)$=+no-remote-exec
560+
common --modify_execution_info=^(BundleApp|BundleTreeApp|CreateArchive|CreateCombinedDossierZip|DsymDwarf|DsymLipo|GenerateAppleSymbolsFile|ObjcBinarySymbolStrip|CppArchive|CppLink|ObjcLink|ProcessAndSign|SignBinary|SwiftArchive|SwiftStdlibCopy)$=+no-remote,^(BundleResources|ImportedDynamicFrameworkProcessor)$=+no-remote-exec
561561
```
562562

563563
The following table provides a rationale for each mnemonic and tag. In general though, the mnemonics that are excluded in `--modify_execution_info` are excluded because they produce or work on large outputs which change frequently and as such are faster when run locally, or they are not generally configured for remote execution (such as signing).
564564

565565
| Mnemonics | Tag | Rationale |
566566
| --- | --- | --- |
567567
| `BundleApp`, `BundleTreeApp`, `ProcessAndSign` | `no-remote` | Produces a large bundle, which is inefficient to upload and download |
568+
| `CreateArchive`, `CreateCombinedDossierZip` | `no-remote` | Produces large archive outputs, and macOS archive packaging relies on preserving bundle symlinks and modes while walking the tree artifact |
568569
| `CppArchive`, `CppLink`, `ObjcLink`, `SwiftArchive` | `no-remote` | Linked binaries have local paths, and it's slower to download them versus linking locally |
569570
| `SwiftStdlibCopy` | `no-remote` | Processing Swift stdlib is a quick file copy of a locally available resource, so it's not worth uploading or downloading |
570571
| `DsymDwarf`, `DsymLipo`, `GenerateAppleSymbolsFile`| `no-remote-exec` | Processing dSYMs/Symbols remotely requires uploading the linked binary; this could go away if you switch to uploading linked binaries |

doc/rules-apple_archive.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ target's unarchived bundle root for IDE consumers.
2626
Example:
2727

2828
````starlark
29-
load("//apple:apple_archive.bzl", "apple_archive")
29+
load("@rules_apple//apple:apple_archive.bzl", "apple_archive")
3030

3131
ios_application(
3232
name = "App",
@@ -47,6 +47,6 @@ apple_archive(
4747
| :------------- | :------------- | :------------- | :------------- | :------------- |
4848
| <a id="apple_archive-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
4949
| <a id="apple_archive-bundle"></a>bundle | The label to a target to re-package into an Apple archive. For example, an `ios_application` or `macos_application` target. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
50-
| <a id="apple_archive-include_symbols"></a>include_symbols | If true, collects `$UUID.symbols` files from all `{binary: .dSYM, ...}` pairs for the application and its dependencies, then packages them under the `Symbols/` directory in the final archive. | Boolean | optional | `False` |
50+
| <a id="apple_archive-include_symbols"></a>include_symbols | If true, collects generated `$UUID.symbols` files from all `{binary: .dSYM, ...}` pairs for the application and its dependencies, then packages them under the `Symbols/` directory in the final archive. Symbol files are only available when dSYM generation is enabled, such as by passing `--apple_generate_dsym`. | Boolean | optional | `False` |
5151

5252

0 commit comments

Comments
 (0)