Always expose interposer API #164
Merged
Conversation
This file contains hidden or 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 interposer API is fairly undiscoverable and the docc catalog does not include the symbols because they are hidden behind a `#if`. This has the knock on affect of not being able to link to the symbols too. This commit changes MMIO to always expose interposing API. The APIs are marked with a deprecation warning when not compiled with `FEATURE_INTERPOSABLE` and are a no-op. As a result the docc catalog now includes documentation for these symbols and can reference them throughout the catalog.
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.
The interposer API is fairly undiscoverable and the docc catalog does not include the symbols because they are hidden behind a
#if. This has the knock on affect of not being able to link to the symbols too.This commit changes MMIO to always expose interposing API. The APIs are marked with a deprecation warning when not compiled with
FEATURE_INTERPOSABLEand are a no-op. As a result the docc catalog now includes documentation for these symbols and can reference them throughout the catalog.