kernel: update platform hooks documentation #97099
Draft
+71
−8
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 hooks' signature was not visible to Doxygen due to preprocessor conditionals - instead, the dummy no-op implementation was seen instead. Update #ifdef guard to make the hooks' signature and the associated documentation visible to Doxygen such that it appears in docs. Also fix a tiny typo on soc_reset_hook()'s documentation comment. Signed-off-by: Mathieu Choplain <[email protected]>
Document the expected early boot sequence and when platform hooks should be called by the arch-specific coode, and under what conditions. Signed-off-by: Mathieu Choplain <[email protected]>
|
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.
(draft until #96962 is merged)
Update documentation related to platform hooks: