nuttxpr commented on PR #15618: URL: https://github.com/apache/nuttx/pull/15618#issuecomment-2602630160
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) No, this PR description does not fully meet the NuttX requirements. Here's why and how to fix it: * **Insufficient Summary:** While it mentions typos and syslog changes, it lacks crucial details. What typos were fixed? Why was the syslog change needed? How does using `lib_syslograwstream_s` specifically address the debugging issue? Be explicit about the problems the changes solve and how they solve them. Link a related NuttX issue if one exists. * **Impact Too Brief:** "No impact" is rarely completely true. While the impact might be minimal, consider the implications more thoroughly. Does the change affect any specific architectures or boards? Does it alter the behavior of the GDB stub in any noticeable way? Even minor changes can have unforeseen consequences. If the impact truly is negligible across all areas, explicitly state "NO" for each impact category (Impact on user: NO, Impact on build: NO, etc.). * **Insufficient Testing Information:** The testing description is far too vague. Provide specific details about your build host (OS version, compiler version). For the targets, specify the NuttX version and configurations used (e.g., `nuttx-X.Y configured with XYZ`). The provided target information (`mps3-an547:nsh` and `stm32f429i-disco:gdbstub`) isn't detailed enough. Critically, the testing logs are missing entirely. Include actual log output demonstrating the issue before the change and the corrected behavior after the change. Show how the changes fixed the problem. **Example of Improved PR Description:** ## Summary This PR fixes several typos in the GDB stub code and improves debug output clarity by using `lib_syslograwstream_s` for newline control. Previously, newline characters were inserted unintentionally, making it difficult to parse debug logs. By using `lib_syslograwstream_s`, newline characters are now only printed when explicitly intended, streamlining the debugging process. The typos corrected included [list specific typos and their locations, e.g., "s/debuggr/debugger/ in gdbstub_xxx.c"]. Relates to [NuttX Issue # if applicable] ## Impact * Impact on user: NO (GDB stub users should not experience any functional changes, only improved debug output). * Impact on build: NO * Impact on hardware: NO (Changes are within the GDB stub and do not affect hardware drivers or configurations). * Impact on documentation: NO * Impact on security: NO * Impact on compatibility: NO * Anything else to consider: NO ## Testing I confirm that changes are verified on local setup and works as intended: * Build Host: Ubuntu 22.04, GCC 11.3.0 * Target(s): * `mps3-an547`: NuttX version `nuttx-X.Y` configured with `nsh` config * `stm32f429i-disco`: NuttX version `nuttx-X.Y` configured with `gdbstub` config Testing logs before change: ``` [gdbstub output with problematic newlines] ... ``` Testing logs after change: ``` [Clean gdbstub output showing improved formatting] ... ``` By providing these specifics, the PR review process becomes significantly more efficient, and the changes are easier to understand and validate. Remember to consult the Contributing Guidelines for further guidance. -- 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
