Remove unused headers from umbrella header directory #1474
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lawrence-forooghian
force-pushed
the
remove-unused-headers-from-umbrella-header-directory
branch
2 times, most recently
from
078a216 to
2ab348a
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1474/jazzydoc
|
CI on this one won't pass until:
|
This commit message is pretty much a copy-and-paste of that of commit 7822a33 in ably/delta-codec-cocoa. The file Source/include/Ably.modulemap contains an umbrella header declaration: > umbrella header "Ably/Ably.h" According to Clang’s modules documentation (https://clang.llvm.org/docs/Modules.html): > An umbrella header includes all of the headers within its directory > Use the -Wincomplete-umbrella warning option to ask Clang to complain > about headers not covered by the umbrella header or the module map. -Wincomplete-umbrella is enabled by default (https://clang.llvm.org/docs/DiagnosticsReference.html#wincomplete-umbrella). Source/include/Ably/Ably.h doesn’t contain an import of its neighbouring files ARTPushActivationEvent.h, ARTPushActivationState.h and ARTPushActivationStateMachine.h (symlinks to headers used internally), which hence triggers the above warning ("umbrella header for module 'Ably' does not include header 'ARTPushActivationEvent.h'" etc) in apps importing the Ably module, i.e. apps importing the Ably SPM package. Those ARTPushActivationEvent.h etc symlinks are _correctly_ not included in the umbrella header since they’re not part of the public interface of this module. Hence the correct thing to do is to delete them.
This would have caught the errors fixed in commit 312be56 of this repo and in commit 7822a33 of ably/delta-codec-cocoa. I followed https://michael-kiley.medium.com/treat-warnings-as-errors-in-a-swift-package-e4429609ec2d.
lawrence-forooghian
force-pushed
the
remove-unused-headers-from-umbrella-header-directory
branch
from
2ab348a to
dd9e462
Compare
lawrence-forooghian
deleted the
remove-unused-headers-from-umbrella-header-directory
branch
lawrence-forooghian
added a commit
that referenced
this pull request
Aug 18, 2022
This is generated by the mysterious github_changelog_generator, plus I added a line about the fix in #1474.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a very similar fix to ably/delta-codec-cocoa#23. It fixes a warning along the lines of
Umbrella header for module 'Ably' does not include header 'ARTPushActivationEvent.h'that occurs when importing this library as an SPM package. I've also changed the build settings for our example SPM package that imports this library, to catch future errors like this.