nuttxpr commented on PR #14307:
URL: https://github.com/apache/nuttx/pull/14307#issuecomment-2413427391

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   
   
   The provided information is missing some key details required by the NuttX 
PR guidelines. 
   
   **Here's a breakdown of what's missing and how to improve the PR:**
   
   * **Summary:**
       * **Why is this change necessary?**  The summary states "adjust gdb 
register order" but doesn't explain why this adjustment is needed. Is there a 
bug in the current register order? Does it not conform to a standard?  Clearly 
state the problem this PR solves.
       * **What functional part of the code is being changed?** Be specific 
about which files and functions are modified. 
   * **Impact:**
       * **Is new feature added? Is existing feature changed?**  Specify 
whether this is a bug fix or an enhancement.
       * **Impact on user:**  While "debug" is mentioned, it's too vague. 
Explain how this change affects users who utilize GDB for debugging on ARMv7-A. 
Will they experience any differences in functionality or behavior?
       * **Impact on build:**  Will this PR change any build steps, 
dependencies, or configurations? 
       * **Impact on documentation:** If the register order impacts how users 
interact with GDB for debugging, then documentation likely needs an update. Be 
explicit about this need.
   * **Testing:**
       * **Build Host(s):** Provide details about the operating system, CPU 
architecture, and compiler used for building and testing.
       * **Target(s):** Be specific about the ARMv7-A target(s) used (e.g., 
QEMU model, physical board).
       * **Testing logs before change:** Include the GDB output *before* the 
change to demonstrate the incorrect register order.
   
   **Improved Summary Example:**
   
   ```
   ## Summary
   
   This PR fixes an issue in the GDB stub for ARMv7-A where the reported 
register order was incorrect. The current implementation does not adhere to the 
standard ARM register order, leading to confusion and potential errors during 
debugging. This change ensures that the register order presented by GDB aligns 
with the expected standard.
   
   This PR modifies the following files:
   * `arch/arm/src/armv7-a/gdb_stub_arch.c`
   
   ## Impact
   
   * **Bug Fix:** This PR addresses a bug in the GDB stub.
   * **Impact on user:** Users debugging ARMv7-A applications with GDB will now 
see a corrected register order, improving debugging accuracy.
   * **Impact on documentation:** The GDB documentation should be updated to 
reflect the corrected register order. 
   * **Impact on build, hardware, security, compatibility:**  NO
   
   ## Testing 
   
   * **Build Host:** Linux (Ubuntu 20.04), x86_64, GCC 9.3.0
   * **Target:** QEMU ARMv7-A (Versatilepb)
   
   **Testing logs before change:**
   ```
   (gdb) maint print remote-registers 
   ... [previous incorrect output] ...
   ```
   
   **Testing logs after change:**
   ```
   (gdb) maint print remote-registers 
   ... [corrected register order output] ... 
   ``` 
   ```
   
   By providing clear and comprehensive information, your PR will be easier for 
maintainers to review and merge. 
   


-- 
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

Reply via email to