Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refine string optimization option #15499

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

xiaoxiang781216
Copy link
Contributor

Summary

  • libc: Rename LIBC_STRING_OPTIMIZE to LIBC_NEWLIB_OPTSPEED
  • libc: Add LIBC_ prefix to MEMCPY_VIK and MEMSET_OPTSPEED

Impact

Kconfig option

Testing

ci

and correct the dependence

Signed-off-by: Xiang Xiao <[email protected]>
@xiaoxiang781216 xiaoxiang781216 added the breaking change This change requires a mitigation entry in the release notes. label Jan 11, 2025
@github-actions github-actions bot added Area: OS Components OS Components issues Board: arm Board: risc-v Board: simulator Board: sparc Size: M The size of the change in this PR is medium labels Jan 11, 2025
@nuttxpr
Copy link

nuttxpr commented Jan 11, 2025

[Experimental Bot, please feedback here]

No. This PR description lacks crucial information required by the NuttX guidelines.

Here's why and what's missing:

  • Insufficient Summary: Simply renaming Kconfig options requires a more detailed explanation. Why are these options being renamed? What problem does this solve? What are the benefits? How do these options relate to string optimization or memcpy/memset speed optimizations?

  • Incomplete Impact: Stating "Kconfig option" is not enough. While it acknowledges a build system change, it lacks specifics. Does this change the default configuration? Will existing user configurations break? Will any rebuild be required? All "Impact" sections should explicitly answer YES/NO then provide details if YES. For example:

    • Impact on user: YES. Users will need to reconfigure their build if they were using the old LIBC_STRING_OPTIMIZE option. The new LIBC_NEWLIB_OPTSPEED option replaces it.
    • Impact on build: YES. Kconfig files are modified.
    • Impact on documentation: Likely YES. Documentation needs to be updated to reflect the new option names.
  • Unacceptable Testing: "ci" is not sufficient. The PR description must include actual test logs demonstrating the change's behavior before and after. What functionality was tested? What were the results? Simply relying on CI tests without providing any context in the PR description is insufficient. The reviewer needs to see evidence within the PR itself. Provide details about the build host and target as requested.

In short: This PR description needs significant expansion to be considered acceptable. It needs to clearly explain the motivation, the detailed impact, and provide concrete testing evidence.

@xiaoxiang781216 xiaoxiang781216 force-pushed the mem branch 2 times, most recently from 9750fa6 to 432fa65 Compare January 12, 2025 08:17
align with other option naming convention

Signed-off-by: Xiang Xiao <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OS Components OS Components issues Board: arm Board: risc-v Board: simulator Board: sparc breaking change This change requires a mitigation entry in the release notes. Size: M The size of the change in this PR is medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants