nuttxpr commented on PR #2665: URL: https://github.com/apache/nuttx-apps/pull/2665#issuecomment-2402202642
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) Let's break down whether this Pull Request (PR) description meets NuttX's requirements. **Summary:** * **Why is the change necessary?** The summary states it adds profiling capability which is useful, but doesn't explicitly state a problem this solves (e.g., "Performance analysis was difficult..."). * **What is being changed?** This is unclear. Mentioning "gprof" implies toolchain changes, but it's not specific to NuttX code. * **How does it work?** The output example is helpful, but a high-level description of how profiling is enabled/used is missing. * **Related issues:** The dependency on another PR is noted, but are there user-facing issues this addresses? **Impact:** * Most fields are left blank. This is where you meticulously detail consequences: * **New feature?** Definitely YES, describe it! * **User impact?** Likely YES, how do they enable/use profiling? * **Build impact?** Maybe YES (new config options?), maybe NO if transparent * **Hardware impact?** Unlikely, but state it explicitly if so * **Documentation?** Crucially YES, this needs user guides * **Security?** Profiling *can* have implications if data is exposed, analyze * **Compatibility?** Unlikely to break things, but be thorough **Testing:** * **Insufficient**. Provide: * Host OS, compiler versions used for building NuttX *itself* * Target architecture and board configuration where profiling was tested * Logs should show: * How profiling was enabled * Relevant commands run (not just gprof's output) * Evidence that results are as expected (did it catch the intended hotspots?) **Verdict:** This PR description is **incomplete**. It highlights a valuable feature but lacks the detail and rigor that NuttX requires. Addressing the points above will make it much stronger. -- 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]
