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

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   
   
   Yes, this PR appears to meet the NuttX requirements, although some minor 
improvements could be made.
   
   **Strengths:**
   
   * The summary clearly explains the change, its purpose, and how it works.
   * The impact section addresses key areas and notes the lack of impact on 
users relying on the existing build system.
   * Testing information includes the host and target details.
   
   **Areas for Improvement (to make it even better):**
   
   * **Summary:** Add a link to the relevant NuttX issue if one exists.  Even 
if this PR doesn't directly address a specific issue, it might be related to 
ongoing CMake build system improvements.  Mentioning this connection can be 
helpful.
   * **Impact:** Explicitly state NO for all other impact categories (user, 
hardware, documentation, security, compatibility) if they truly are not 
affected.  This adds clarity.
   * **Testing:**
       * The CMake command should be the exact command used.  Don't say "likely 
similar to."  Provide the precise command so it's reproducible.
       * "Flashed and ran different programs many times without any errors" is 
vague. Be specific!  Which programs? What functionality was tested? What 
constituted a successful test?  Consider providing snippets of output showing 
expected behavior.  Ideally, the logs before/after wouldn't be empty. While 
they might not be applicable in all scenarios, if there's any relevant output 
showing the change's effect, include it.  Even a simple "Hello, World" example 
running successfully via CMake vs. make would be better than nothing.
       * Be explicit about the tools used: "Flashed using OpenOCD (version 
X.Y.Z)" or similar.
   
   **Example of improved testing section:**
   
   ```
   ## Testing
   
   I confirm that changes are verified on the local setup and work as intended:
   
   * **Build Host:** WSL2 Ubuntu 24.04, Intel Core i5 10th Gen (Hexacore), 
CMake version X.Y.Z, Ninja version A.B.C
   * **Target:** `tm4c123g-launchpad`, OpenOCD version P.Q.R
   
   * **Verification Steps:**
       1. Navigated to the root NuttX directory: `nuttxspace/nuttx`.
       2. Executed the following CMake command: `cmake -B build 
-DBOARD_CONFIG=tm4c123g-launchpad:nsh -GNinja`
       3. Built NuttX: `ninja -C build`
       4. Flashed the built `nuttx.bin` to the tm4c123g-launchpad using 
OpenOCD:  `openocd -f interface/stlink-v2.cfg -f target/tm4c123gh6pm.cfg -c 
"program build/nuttx.bin verify reset exit"`  (Replace with your actual OpenOCD 
command and config files.)
       5. Connected to the board's serial console.
       6. Verified the NSH console started successfully by observing the NSH 
prompt: `nsh>`
       7. Executed the `hello` command within NSH and observed the expected 
output: `Hello, World!`
   
   Testing logs after change (NSH interaction):
   
   ```
   nsh> hello
   Hello, World!
   nsh>
   ```
   ```
   
   
   By adding this level of detail, reviewers can easily reproduce your testing 
and have more confidence in 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: commits-unsubscr...@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to