nuttxpr commented on PR #14333: URL: https://github.com/apache/nuttx/pull/14333#issuecomment-2414253660
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) The provided PR description does not meet the NuttX requirements. Here's why and how to improve it: **Missing Information:** * **Insufficient Summary:** * **Why is the change necessary?** The description vaguely mentions a "hci driver bug" and a problem with `btuart_rxwork` and `btuart_read`, but doesn't clearly explain the bug's symptoms or root cause. * **What functional part of the code is changed?** Be specific about the files and functions modified. * **How does the change work?** Provide a technical explanation of the solution implemented. * **Issue References:** Link any related NuttX or NuttX Apps issues. * **Incomplete Impact Assessment:** * **Impact on User:** Will users experience any functional changes? How will this fix manifest for them? * **Impact on Build/Hardware/Documentation/Security/Compatibility:** While you marked some as "NO," it's crucial to review *all* categories and explain why there's no impact or provide details if there is. * **Insufficient Testing Details:** * **Build Host(s):** Specify the operating system, CPU architecture, and compiler used for testing. * **Target(s):** List the target architectures (e.g., simulator, ARM) and boards used for verification. * **Testing Logs:** Instead of "Testing by self-test passed", include relevant snippets from the logs demonstrating the issue before the fix and the successful behavior after. **How to Improve the PR Description:** 1. **Elaborate on the Summary:** - **Problem:** Clearly describe the Bluetooth HCI driver bug. What goes wrong, and what are the consequences? - **Solution:** Explain how your changes fix the issue. For example, do you modify how data is read in blocking mode? Do you adjust the number of times `btuart_read` is called? - **Code Changes:** Specify the files and functions you modified. 2. **Complete the Impact Assessment:** - Carefully consider each category. Even if there's no impact, briefly explain why. For example: "Impact on Build: NO - This change only affects the Bluetooth HCI driver implementation and does not modify the build process." 3. **Provide Detailed Testing Information:** - List all build hosts and target environments. - Include relevant log excerpts that showcase: - The error or unexpected behavior before your changes. - The correct, expected behavior after applying your fix. **Example of an Improved Summary:** "**Fix: Bluetooth HCI Driver Data Loss in Blocking Mode** This PR addresses a bug in the Bluetooth HCI driver where data could be lost when reading in blocking mode. The issue arises because `btuart_read` was being called three times consecutively, potentially missing subsequent packets received during the first read. The fix modifies `btuart_rxwork` to read data in blocking mode until a complete packet is received. This ensures that no data is lost due to premature calls to `btuart_read`. **Changes:** - `drivers/bluetooth/hci/btuart.c`: Modified `btuart_rxwork` to read data in blocking mode until a full packet is available." **Remember:** A well-written PR description saves reviewers time and helps ensure your changes are understood, reviewed effectively, and merged smoothly. -- 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
