Add more comment for core affinity in prvSelectHighestPriorityTask

chinglee-iot commented 1 year ago

Description

Add more comments for core affinity in prvSelectHighestPriorityTask to explain the logic. Forum user feeds back questions about the core select logic for core affinity feature. This PR adapts some the discussion in the comment to help reader understand the logic in this function.

Test Steps

Checklist:

[ ] ~~I have tested my changes. No regression in existing tests.~~
[ ] ~~I have modified and/or added unit-tests to cover the code changes in this Pull Request.~~

Related Issue

Link to forum questions

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov[bot] commented 1 year ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (317bc0c) 93.62% compared to head (03f5168) 93.62%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #801 +/- ## ======================================= Coverage 93.62% 93.62% ======================================= Files 6 6 Lines 2508 2508 Branches 598 598 ======================================= Hits 2348 2348 Misses 107 107 Partials 53 53 ``` | [Flag](https://app.codecov.io/gh/FreeRTOS/FreeRTOS-Kernel/pull/801/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/FreeRTOS/FreeRTOS-Kernel/pull/801/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS) | `93.62% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/FreeRTOS/FreeRTOS-Kernel/pull/801?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS) | Coverage Δ | | |---|---|---| | [tasks.c](https://app.codecov.io/gh/FreeRTOS/FreeRTOS-Kernel/pull/801?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=FreeRTOS#diff-dGFza3MuYw==) | `94.81% <ø> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.