Thank you for your contribution! Sashiko AI review found 1 potential issue(s) 
to consider:
- [Low] Multiple typographical errors, misspelled constant names, and a 
copy-paste error exist in the newly added Sahara protocol documentation.
--

Note: The format of this report has been altered to provide a free-form summary 
of the findings rather than inline code quotes, due to strict content 
recitation restrictions.

commit ea565b1ec139594103ddde3b826aade3f2071329
Author: Kishore Batta <[email protected]>

Add documentation for Sahara protocol

This commit introduces documentation for the Qualcomm Sahara protocol. It 
details operational modes such as image transfer, memory debug, and command 
mode, explaining their functions and respective packet flows.

[Severity: Low]
This isn't a bug, but there is a typo in the mode constant name defined around 
line 206 in Documentation/mhi/sahara_protocol.rst. It is written as 
SAHARA_MODE_MEMORY_DBEUG instead of SAHARA_MODE_MEMORY_DEBUG. Could this typo 
mislead developers who are referencing the protocol definitions in their code?

[Severity: Low]
In the "Packet flow for memory debug" section around line 814, the text 
introduces the sequence with "The packet flow sequence for image transfer is as 
follows:". Is this a copy-paste error from the previous section? Should it 
refer to "memory debug" instead of "image transfer" here?

[Severity: Low]
There are several typographical errors scattered throughout the new 
documentation file that might be worth correcting for overall clarity and 
professionalism. These include:

- "sate" instead of "state" (e.g., in "Reset Sahara sate machine packet")
- "Sahar" instead of "Sahara" (e.g., "The Sahar client interprets")
- "pcket" instead of "packet" (e.g., "content from the data pcket is written")
- "targert" instead of "target" (e.g., "transferring the image header to the 
targert")
- "successgul" instead of "successful" (e.g., "receives a successgul end of 
image")
- "firgure" instead of "figure" (e.g., "The below firgure shows")

Would it be possible to fix these minor typos in a subsequent revision?

-- 
Sashiko AI review ยท 
https://sashiko.dev/#/patchset/20260701-sahara_protocol_new_v2-v6-0-3a78362c4...@oss.qualcomm.com?part=1

Reply via email to