Re: [PATCH v8 1/7] Add documentation for Sahara protocol

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] docs: typos, copy-paste errors, and ReST formatting issues in sahara_protocol.rst
--

Describe the issue without repeating the exact code. Place the [Severity: <level>] tag before each description.

I repeat: DO NOT QUOTE DIFFS using '>' or any block-quoting format. You may use tiny inline snippets if absolutely necessary, but no large blocks of code. Do not include diff headers (`diff --git`, `index`, `---`, `+++`, `@@`).

Generate the review report directly.commit ab93a6140a5ba3ed32ff6b359193e1a5caa55f4c
Author: Kishore Batta <kishore.batta@oss.qualcomm.com>

Add documentation for Sahara protocol

This commit introduces new documentation for the Sahara protocol, covering
its operational modes, image transfer, memory debug, and command modes used
for operations like retrieving DDR training data.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Command packet optional
fields table, there is a typo for the Reset Sahara state machine packet. The
field mentions 'sate machine' instead of 'state machine'.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Hello Packet mode table,
there is a typo in the constant name for memory debug mode. It is written as
SAHARA_MODE_MEMORY_DBEUG but should probably be SAHARA_MODE_MEMORY_DEBUG.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst, also within the Hello Packet mode
table description for SAHARA_MODE_COMMAND, there is a typo. It mentions 'The
Sahar client interprets' instead of 'Sahara'.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Hello response packet
section, the numbered list explaining the response contents immediately
follows the preceding sentence without a blank line. In ReST formatting,
this missing blank line causes the numbered list items to be squashed into a
single continuous paragraph when rendered.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Write data packet
section, there are two typos in the same sentence. It says 'data pcket is
written to the output file, The format...'. 'pcket' should be 'packet', and
there is a comma splice where a period should be used before 'The'.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Packet flow for Image
transfer section (step 6), there is a typo where 'targert' is used instead
of 'target'.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Packet flow for Image
transfer section (step 8), there is a typo where it says 'successgul'
instead of 'successful'.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Packet flow for memory
debug section, immediately following the packet diagram, the text says 'The
packet flow sequence for image transfer is as follows:'. This appears to be
a copy-paste error from the previous section and should likely say 'for
memory debug'.

[Severity: Low]
In Documentation/mhi/sahara_protocol.rst under the Subsequent boot scenario
section, there is a typo in the introductory sentence. It says 'The below
firgure' instead of 'figure'.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261012-sahara_protocol_new_v2-v8-0-e12939d229a1@oss.qualcomm.com?part=1