Remove unused config.h header from umbrella header directory
#23
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
The file include/AblyDeltaCodec.modulemap contains an umbrella header declaration: > umbrella header "AblyDeltaCodec/AblyDeltaCodec.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). include/AblyDeltaCodec/AblyDeltaCodec.h doesn’t contain an import of its neighbouring file config.h (a symlink to a header used internally), which hence triggers the above warning ("umbrella header for module 'AblyDeltaCodec' does not include header 'config.h'") in apps importing the AblyDeltaCodec module, i.e. apps importing the AblyDeltaCodec SPM package. That config.h symlink is _correctly_ not included in the umbrella header since it is not part of the public interface of this module. Hence the correct thing to do is to delete it. Closes #15.
lawrence-forooghian
force-pushed
the
remove-unused-headers-from-umbrella-header-directories
branch
from
a9b6939 to
7822a33
Compare
Seems like the currently specified versions are no longer available on the latest GitHub runners.
lawrence-forooghian
force-pushed
the
remove-unused-headers-from-umbrella-header-directories
branch
from
ed367ef to
7d6ef9d
Compare
maratal
approved these changes
Aug 17, 2022
lawrence-forooghian
deleted the
remove-unused-headers-from-umbrella-header-directories
branch
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 fixes a warning that some users were seeing when importing this library as a transitive dependency of ably-cocoa. See commit message for more details.
(I also had to tweak some CI config because it's been so long since we last ran a CI job in this repo.)
Closes #15.