[03/35] Documentation: block: correct spelling

Message ID 20230127064005.1558-4-rdunlap@infradead.org
State New
Headers
Series Documentation: correct lots of spelling errors (series 1) |

Commit Message

Randy Dunlap Jan. 27, 2023, 6:39 a.m. UTC
  Correct spelling problems for Documentation/block/ as reported
by codespell.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/block/data-integrity.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Bagas Sanjaya Jan. 27, 2023, 8:31 a.m. UTC | #1
On Thu, Jan 26, 2023 at 10:39:33PM -0800, Randy Dunlap wrote:
> diff -- a/Documentation/block/data-integrity.rst b/Documentation/block/data-integrity.rst
> --- a/Documentation/block/data-integrity.rst
> +++ b/Documentation/block/data-integrity.rst
> @@ -209,7 +209,7 @@ will require extra work due to the appli
>        sector must be set, and the bio should have all data pages
>        added.  It is up to the caller to ensure that the bio does not
>        change while I/O is in progress.
> -      Complete bio with error if prepare failed for some reson.
> +      Complete bio with error if prepare failed for some reason.
>  

So if prepare returns error, bio is completed not successfully but also
errored?
  
Mukesh Ojha Jan. 27, 2023, 8:36 a.m. UTC | #2
>Correct spelling problems for Documentation/block/ as reported
>by codespell.
>
>Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com>

-Mukesh
  
Randy Dunlap Jan. 27, 2023, 10:58 p.m. UTC | #3
On 1/27/23 00:31, Bagas Sanjaya wrote:
> On Thu, Jan 26, 2023 at 10:39:33PM -0800, Randy Dunlap wrote:
>> diff -- a/Documentation/block/data-integrity.rst b/Documentation/block/data-integrity.rst
>> --- a/Documentation/block/data-integrity.rst
>> +++ b/Documentation/block/data-integrity.rst
>> @@ -209,7 +209,7 @@ will require extra work due to the appli
>>        sector must be set, and the bio should have all data pages
>>        added.  It is up to the caller to ensure that the bio does not
>>        change while I/O is in progress.
>> -      Complete bio with error if prepare failed for some reson.
>> +      Complete bio with error if prepare failed for some reason.
>>  
> 
> So if prepare returns error, bio is completed not successfully but also
> errored?

I think that
>> +      Complete bio with error if prepare failed for some reason.
says that the caller of bio_integrity_prep() should treat the bio as an
error condition. I don't see any guarantee that the bio is completed
as far as adding an integrity payload to it, any more than what the bio
was upon calling bio_integrity_prep().

But I could also be wrong.  :)
  

Patch

diff -- a/Documentation/block/data-integrity.rst b/Documentation/block/data-integrity.rst
--- a/Documentation/block/data-integrity.rst
+++ b/Documentation/block/data-integrity.rst
@@ -209,7 +209,7 @@  will require extra work due to the appli
       sector must be set, and the bio should have all data pages
       added.  It is up to the caller to ensure that the bio does not
       change while I/O is in progress.
-      Complete bio with error if prepare failed for some reson.
+      Complete bio with error if prepare failed for some reason.
 
 
 5.3 Passing Existing Integrity Metadata