Skip to content

Commit 6d4e91d

Browse files
committed
WiX: update documentation to include DocC properties
We cannot build DocC everywhere yet (primarily Windows ARM64 cannot be built due to the use of SPM). Document the properties that we use to control the packaging with regards to DocC.
1 parent 59a594b commit 6d4e91d

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

platforms/Windows/readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ MSBuild automatically imports Directory.Build.props files in your tree. We use D
106106
| ArePackageCabsEmbedded | Always set to false to keep the .cab files external to the .msi files. This save user disk space: Burn caches packages so it can always uninstall and repair. MSI also caches packages for uninstall. If the cab is embedded, you have two copies and MSI doesn't always use its cached copy as a source for repair. With an external .cab, MSI caches only the tiny .msi file and not the (relatively huge) .cab. |
107107
| BundleFlavor, IsBundleCompressed | BundleFlavor defaults to `online` to build an online bundle. Set by the invocation of MSBuild to build an online or offline bundle. Controls IsBundleCompressed. |
108108
| DefineConstants | Passes a subset of MSBuild properties into the WiX build as preprocessor variables. |
109+
| INCLUDE_SWIFT_DOCC | swift-docc is currently conditionalized out. Set it to `true` to include it. The property `SWIFT_DOCC_BUILD` defines the directory to find the artifacts. |
109110
| INCLUDE_SWIFT_INSPECT | swift-inspect is currently conditionalized out. Set it to `true` to include it. The property `SWIFT_INSPECT_BUILD` defines the directory to find the artifacts. |
110111
| INCLUDE_X86_SDK, INCLUDE_ARM64_SDK | The x86 and Arm64 SDKs are currently conditionalized out, pending build changes. Set these to `true` to include them in the bundles. Note that bundle\theme.xml currently has commented-out checkboxes that need to be restored when the x86 and Arm64 SDKs are brought back. |
111112

0 commit comments

Comments
 (0)