nuttxpr commented on PR #16297: URL: https://github.com/apache/nuttx/pull/16297#issuecomment-2844974547
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) This PR description needs improvement to meet NuttX standards. Here's a revised version: ``` ## Summary Fix: Handle empty lines in Kconfig .config files This PR addresses an issue where empty lines in the `.config` file caused subsequent configuration options to be erased during processing by `process_config.sh`. This prevented using Kconfig-based `defconfig` files containing empty lines. The issue was encountered while trying to configure a custom board. Fixes #[Insert NuttX Issue Number Here - Create one if it doesn't exist] ## Impact * **Is new feature added? Is existing feature changed?** Existing feature (configuration processing) is changed. * **Impact on user:** YES. Users can now use `defconfig` files containing empty lines. Previously, these files would lead to incorrect configurations. * **Impact on build:** YES. The `process_config.sh` script now correctly handles empty lines. * **Impact on hardware:** NO. * **Impact on documentation:** NO. Although a mention of this fix in release notes or the contributing guide might be beneficial for future reference. * **Impact on security:** NO. * **Impact on compatibility:** YES. Improves backward compatibility by allowing the use of more diversely formatted `.config` files. Forward compatibility is unaffected. Interoperability is not impacted. * **Anything else to consider?** The current fix focuses on preventing data loss due to empty lines. While preserving empty lines in the final `.config` might be aesthetically pleasing, it's not functionally necessary. A warning about empty lines during configuration processing could be considered if deemed important. ## Testing I confirm that changes are verified on a local setup and work as intended: * **Build Host(s):** [Specify your Build Host OS, CPU Architecture, and Compiler Version e.g., Linux (Ubuntu 20.04), x86_64, GCC 9.4.0] * **Target(s):** [Specify your Target Architecture and Board Configuration e.g., sim:qemu-arm, arm:stm32h743-custom] **Testing logs before change:** [Pastebin link is acceptable, but ideally include a concise, representative snippet demonstrating the failure directly in the PR] For example: ``` Configuring with defconfig containing empty lines... Error: CONFIG_ARCH setting missing. Build failed. ``` **Testing logs after change:** [Again, a concise snippet is preferred] ``` Configuring with defconfig containing empty lines... Configuration successful. CONFIG_ARCH=arm ``` ``` Key improvements: * **Clearer Summary:** Directly states the problem and solution. * **Specific Impact Assessment:** Provides more detail and directly answers the questions. * **Detailed Testing Information:** Includes host and target details. Emphasizes the importance of including representative log snippets directly in the PR for easier review. * **Removed Unnecessary Background:** The lengthy explanation of the debugging process is generally not required in the PR itself. This level of detail is better suited for comments within the code or during discussions on the related issue. * **Focus on the Solution:** The description now clearly explains the implemented fix and its effects. * **NuttX Issue Reference:** Emphasized the need to link a NuttX issue. By following this revised structure and providing specific details, you'll create a much more effective NuttX PR that is easier to review and merge. Remember to create a corresponding issue in the NuttX issue tracker if one doesn't already exist. -- 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: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
