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

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   
   
   **No, this PR summary does not meet the NuttX requirements.**
   
   **Here's why and how to improve it:**
   
   **Summary:**
   
   * **Insufficient Detail:** The summary provides a list of changes but lacks 
context and explanation. 
   * **Missing Information:**  
       * **Why:**  The reason for each change (fix, update, feature) is not 
stated.  
       * **What:** A clear description of what part of the code is affected is 
needed. For example, "Modify the method for obtaining the CPU frequency" is 
vague. *Which* method? Where is it located?
       * **How:** How each change works is unclear.  For instance, how is the 
CPU frequency obtained now, and how will it be obtained after the change? 
   * **No Issue References:**  Include any related NuttX or NuttX Apps issues 
or pull requests.
   
   **Impact:**
   
   * **Incomplete:** You need to address *all* impact categories, even if the 
answer is "NO."  Provide brief explanations for each "YES." 
   
   **Testing:**
   
   * **Insufficient Information:**
       * **Build Hosts:** List the specific operating systems, CPUs, and 
compiler versions used for testing.
       * **Targets:** Be specific about the architectures, boards, and 
configurations tested.
       * **Missing Logs:** You must include actual testing logs from *before* 
and *after* your changes.
   
   **How to Write a Better Summary (Example):**
   
   ```
   ## Summary
   
   This PR addresses [NuttX Issue #] by implementing support for the PL031 
timer driver on the goldfish platform and enhancing CPU frequency acquisition 
and performance monitoring for the ARM64 architecture. 
   
   Specifically, it:
   
   1. **Adds pl031 support to goldfish:config:** This enables the use of the 
PL031 timer on the goldfish emulator.
   2. **Modifies CPU frequency acquisition (arch/arm64):** Improves the 
accuracy and reliability of CPU frequency retrieval by [explain the new method 
and why it's better].
   3. **Initializes perf for ARM64 QEMU (arch/arm64/qemu):** Enables 
performance monitoring capabilities within the QEMU environment for ARM64. 
   4. **Adds cluster PMU support (arch/arm64):** Introduces support for 
cluster-level Performance Monitoring Units on ARM64, allowing for more granular 
performance analysis.
   
   ## Impact 
   
   * **Is new feature added?** YES (pl031 support on goldfish, perf 
initialization on ARM64 QEMU, cluster PMU support) 
   * **Impact on user:** YES. Users running on goldfish can now leverage the 
pl031 timer. Developers debugging on ARM64 QEMU can utilize perf tools.
   * **Impact on build:** NO
   * **Impact on hardware:** NO
   * **Impact on documentation:** YES. Documentation will be updated to reflect 
the new pl031 driver configuration, CPU frequency acquisition method, perf 
usage, and cluster PMU support.
   * **Impact on security:** NO
   * **Impact on compatibility:** NO
   * **Anything else to consider:** N/A
   
   ## Testing 
   
   **Build Host(s):**
   * Linux (Ubuntu 20.04), Intel Core i7, GCC 9.4.0
   
   **Target(s):**
   * ARM64 (QEMU virt machine), goldfish:config
   
   **Testing logs before change:** 
   [Insert logs showing the behavior before your changes]
   
   **Testing logs after change:**
   [Insert logs demonstrating the correct functionality after your changes] 
   ```
   
   **Remember:** A well-written PR summary and impact assessment significantly 
helps reviewers understand and evaluate your 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]

Reply via email to