siddhitripathi25 commented on issue #16420:
URL: https://github.com/apache/nuttx/issues/16420#issuecomment-3922471285
Hi @raiden00pl , @acassis, @xiaoxiang781216,
I'm a first-year student contributing to the nuttx-website repository, and
I'm
interested in helping address the documentation aspects of this issue.
I've observed that:
1. This issue demonstrates a fundamental confusion point: users see CONFIG_
macros in code and assume they come from Kconfig/.config
2. The discussion shows this is a widespread problem ("many places in NuttX")
3. The community is actively discussing solutions
As part of improving NuttX documentation, I'm proposing to create a
comprehensive **Configuration Guide** that would help users understand:
- Where configuration values should come from (Kconfig only)
- Why hardcoded CONFIG_ defines in source code are problematic
- How to identify and work around existing hardcoded values
- Best practices for configuration (addressing the "remove CONFIG_ prefix"
suggestion from @xiaoxiang781216)
I'd like to ensure my documentation addresses the pain points raised here.
Specifically, would it be helpful to include:
1. A section explaining "CONFIG_ macros: Kconfig vs Source Code"
2. Guidance on how to verify if a CONFIG_ value truly comes from Kconfig
3. Migration tips for when these hardcoded values are eventually moved to
Kconfig
This documentation would complement the code cleanup work discussed here.
Thank you for raising this important issue!
Best regards,
Siddhi Tripathi
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
