nuttxpr commented on PR #14179: URL: https://github.com/apache/nuttx/pull/14179#issuecomment-2408547730
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) The provided PR summary is **insufficient** to meet the NuttX requirements. Here's why and how to improve it: **Missing Information:** * **Reason for Change:** The summary simply states "Add the default CPU frequency configuration." It needs to explain **why** this change is necessary. * Is there a bug being fixed where the CPU frequency isn't set correctly? * Is this a new feature to allow easier configuration? * Provide context! * **Functionality:** Be specific about what part of the code is changed. * Where is this default configuration being added? * What file(s) are modified? * Are new functions or data structures introduced? * **Mechanism:** How does this change actually work? * How is the default frequency determined? * Is it a compile-time setting? Read from hardware? Configurable by the user? * **Testing Details:** The "Testing" section is entirely placeholder text. You **must** provide: * Specific build host details (OS, CPU architecture, compiler version) * Specific target details (architecture, board, configuration) * Relevant logs demonstrating the behavior before and after your change **Example Improvements:** **Summary:** > **Fix(CPU): Set Default CPU Frequency at Startup** > > This change addresses an issue where the CPU frequency was not being initialized correctly on startup, leading to unpredictable system behavior. It introduces a default CPU frequency configuration within the [specific file/location] that is applied during system initialization. The default frequency is determined by [explain how it's determined - e.g., reading hardware registers, compile-time constant, etc.]. **Impact:** > * **New feature added?** NO > * **Existing feature changed?** YES - CPU frequency initialization behavior > * **Impact on user:** Users should see improved system stability and potentially performance improvements due to the correct CPU frequency being set. > * **Impact on build:** NO > * **Impact on hardware:** This change may have a minor impact on power consumption depending on the default frequency chosen. > * ... [Complete other sections] **Testing:** > **Build Host:** > * OS: Ubuntu 20.04 > * CPU: x86-64 (Intel Core i7-XXXX) > * Compiler: GCC 9.3.0 > > **Target:** > * Architecture: ARM Cortex-M4 > * Board: STM32F4 Discovery (stm32f4discovery) > * Configuration: Default > > **Testing logs before change:** > ``` > [Show relevant log output indicating the incorrect CPU frequency or related issues] > ``` > > **Testing logs after change:** > ``` > [Show log output demonstrating the correct CPU frequency being set] > ``` **Remember:** A good PR description saves everyone time and makes it much more likely your contribution will be accepted! -- 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]
