Update swift_import docs and add warning (#1186)

Updates the `swift_import` documentation to provide more information on the `swiftinterface` attribute. This attribute is required when importing pre-built Swift targets across Xcode and/or OS versions. Additionally, adds a warning when `swiftinterface` is used alongside `swiftmodule` as this used to just drop `swiftinterface` silently. We'll make this a failure in a new major version to not break users. Co-authored-by: John Szumski <[email protected]>
bazelbuild · Apr 1, 2024 · 72347ab · 72347ab
1 parent 31d9ee6
commit 72347ab
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 3 deletions.
diff --git a/doc/rules.md b/doc/rules.md
@@ -438,9 +438,21 @@ package.
 swift_import(<a href="#swift_import-name">name</a>, <a href="#swift_import-deps">deps</a>, <a href="#swift_import-data">data</a>, <a href="#swift_import-archives">archives</a>, <a href="#swift_import-module_name">module_name</a>, <a href="#swift_import-swiftdoc">swiftdoc</a>, <a href="#swift_import-swiftinterface">swiftinterface</a>, <a href="#swift_import-swiftmodule">swiftmodule</a>)
 </pre>
 
-Allows for the use of Swift textual module interfaces and/or precompiled Swift modules as dependencies in other
+Allows for the use of Swift textual module interfaces or precompiled Swift modules as dependencies in other
 `swift_library` and `swift_binary` targets.
 
+To use `swift_import` targets across Xcode versions and/or OS versions, it is required to use `.swiftinterface` files.
+These can be produced by the pre-built target if built with:
+
+  - `--features=swift.enable_library_evolution`
+  - `--features=swift.emit_swiftinterface`
+
+If the pre-built target supports `.private.swiftinterface` files, these can be used instead of `.swiftinterface` files
+in the `swiftinterface` attribute.
+
+To import pre-built Swift modules that use `@_spi` when using `swiftinterface`,
+the `.private.swiftinterface` files are required in order to build any code that uses the API marked with `@_spi`.
+
 **ATTRIBUTES**
 
 
@@ -452,7 +464,7 @@ Allows for the use of Swift textual module interfaces and/or precompiled Swift m
 | <a id="swift_import-archives"></a>archives |  The list of `.a` files provided to Swift targets that depend on this target.   | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional |  `[]`  |
 | <a id="swift_import-module_name"></a>module_name |  The name of the module represented by this target.   | String | required |  |
 | <a id="swift_import-swiftdoc"></a>swiftdoc |  The `.swiftdoc` file provided to Swift targets that depend on this target.   | <a href="https://bazel.build/concepts/labels">Label</a> | optional |  `None`  |
-| <a id="swift_import-swiftinterface"></a>swiftinterface |  The `.swiftinterface` file that defines the module interface for this target.   | <a href="https://bazel.build/concepts/labels">Label</a> | optional |  `None`  |
+| <a id="swift_import-swiftinterface"></a>swiftinterface |  The `.swiftinterface` file that defines the module interface for this target. The interface files are ignored if `swiftmodule` is specified.   | <a href="https://bazel.build/concepts/labels">Label</a> | optional |  `None`  |
 | <a id="swift_import-swiftmodule"></a>swiftmodule |  The `.swiftmodule` file provided to Swift targets that depend on this target.   | <a href="https://bazel.build/concepts/labels">Label</a> | optional |  `None`  |
 
 

diff --git a/swift/internal/swift_import.bzl b/swift/internal/swift_import.bzl
@@ -88,6 +88,9 @@ def _swift_import_impl(ctx):
             module_context.swift.swiftmodule,
         ] + compact([module_context.swift.swiftdoc])
     else:
+        # TODO: make this a failure in version 2.x
+        if swiftinterface:
+            print("WARNING: Provided `swiftinterface` attribute will be ignored because `swiftmodule` was provided. This will be an error in a future version of rules_swift.")  # buildifier: disable=print
         module_context = swift_common.create_module(
             name = ctx.attr.module_name,
             clang = swift_common.create_clang_module(
@@ -161,6 +164,7 @@ The `.swiftdoc` file provided to Swift targets that depend on this target.
                 allow_single_file = ["swiftinterface"],
                 doc = """\
 The `.swiftinterface` file that defines the module interface for this target.
+The interface files are ignored if `swiftmodule` is specified.
 """,
                 mandatory = False,
             ),
@@ -181,8 +185,20 @@ toolchain (such as `clang`) will be retrieved.
         },
     ),
     doc = """\
-Allows for the use of Swift textual module interfaces and/or precompiled Swift modules as dependencies in other
+Allows for the use of Swift textual module interfaces or precompiled Swift modules as dependencies in other
 `swift_library` and `swift_binary` targets.
+
+To use `swift_import` targets across Xcode versions and/or OS versions, it is required to use `.swiftinterface` files.
+These can be produced by the pre-built target if built with:
+
+  - `--features=swift.enable_library_evolution`
+  - `--features=swift.emit_swiftinterface`
+
+If the pre-built target supports `.private.swiftinterface` files, these can be used instead of `.swiftinterface` files
+in the `swiftinterface` attribute.
+
+To import pre-built Swift modules that use `@_spi` when using `swiftinterface`,
+the `.private.swiftinterface` files are required in order to build any code that uses the API marked with `@_spi`.
 """,
     fragments = ["cpp"],
     implementation = _swift_import_impl,