nuttxpr commented on PR #14510: URL: https://github.com/apache/nuttx/pull/14510#issuecomment-2437488579
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) The PR summary doesn't fully meet the NuttX requirements. Here's why and how to improve it: **What's Missing/Needs Improvement** * **Why change is necessary?** - While the summary mentions saving two statements, it lacks a clear explanation of the benefit. Is this a performance optimization? Code size reduction? * **Impact on user (will user need to adapt to change)?** - Even if the answer is NO, the PR needs to explicitly state it. * **Testing:** * **Build Host(s):** Be specific about the OS, CPU, and compiler used. * **Target(s):** Specify the architecture (e.g., sim, ARM) and board configuration used for testing. * **Testing logs:** The PR should ideally include snippets of logs (before and after) to demonstrate the change's effect. This could be related to code size, performance benchmarks, or simply showing the output with and without the return value. **How to Improve the PR Summary** 1. **Clarify the "Why":** * "This change removes the unused return value from `up_putc()` to slightly reduce code size and improve performance by eliminating unnecessary instructions." 2. **Explicitly State User Impact (Even if None):** * "This change has no impact on users. No modifications to application code are required." 3. **Provide Detailed Testing Information:** * **Build Host:** "This change was tested on Ubuntu 20.04 with an Intel Core i7 processor using GCC 9.4.0." * **Target:** "Testing was performed on the QEMU simulator (qemu-system-arm) with the STM32F4Discovery board configuration." * **Testing Logs (Example):** ``` # Before change (showing code size): ... text data bss dec hex filename ... # After change: ... text data bss dec hex filename ... ``` **By making these changes, the PR summary will be more complete and informative, making it easier for reviewers to understand and approve the changes.** -- 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]
