refine code comments: clarify misleading names and comments for thread_rpc_alloc_*_payload APIs
#7096
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
…ad_rpc_alloc_*_payload` APIs The `thread_rpc_alloc_*_payload` APIs are consistent with the `thread_shm_type` enumerations, as seen in the `alloc_shm` function. However, the name and comments of `thread_rpc_alloc_payload` might be misleading, suggesting it is a universal API. To maintain backward compatibility, only the code comments have been updated for clarity.
etienne-lms
reviewed
Oct 30, 2024
There was a problem hiding this comment.
Could you make header file lines and commit message lines be 80char/line max.
The commit header file is too long and would preferably start with core: thread:, maybe: core: thread: clarify thread_rpc_alloc_*_payload() inline description.
Please add your Signed-off-by tag in the commit message (see contribution).
| @@ -244,7 +244,8 @@ bool thread_is_in_normal_mode(void); | |||
| bool thread_is_from_abort_mode(void); | |||
|
|
|||
| /** | |||
| * Allocates data for payload buffers. | |||
| * Allocates data for payload buffers only shared with user space applications. | |||
| * Ensure consistency with the enumeration `THREAD_SHM_TYPE_APPLICATION`. | |||
There was a problem hiding this comment.
That not entirely true: only is misleading. Maybe prefer Allocate data for payload buffers shared with a non-secure user space application.
Prefer drop the back quotes around THREAD_SHM_TYPE_APPLICATION.
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
thread_rpc_alloc_*_payloadAPIs are consistent with thethread_shm_typeenumerations, as seen in thealloc_shmfunction. However, the name and comments ofthread_rpc_alloc_payloadmight be misleading, suggesting it is a universal API. To maintain backward compatibility, only the code comments have been updated for clarity.