Documentation/accel/qaic: Fix typo 'phsyical'

[PATCH] Documentation/accel/qaic: Fix typo 'phsyical'

Posted by Danish Prakash 1 year, 8 months ago

(as part of LFX Linux Mentorship program)

Signed-off-by: Danish Prakash <contact@danishpraka.sh>
---
 Documentation/accel/qaic/qaic.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/accel/qaic/qaic.rst b/Documentation/accel/qaic/qaic.rst
index efb7771273bb..628bf2f7a416 100644
--- a/Documentation/accel/qaic/qaic.rst
+++ b/Documentation/accel/qaic/qaic.rst
@@ -93,7 +93,7 @@ commands (does not impact QAIC).
 uAPI
 ====
 
-QAIC creates an accel device per phsyical PCIe device. This accel device exists
+QAIC creates an accel device per physical PCIe device. This accel device exists
 for as long as the PCIe device is known to Linux.
 
 The PCIe device may not be in the state to accept requests from userspace at
-- 
2.45.1

Re: [PATCH] Documentation/accel/qaic: Fix typo 'phsyical'

Posted by Shuah Khan 1 year, 8 months ago

On 5/31/24 00:09, Danish Prakash wrote:
> (as part of LFX Linux Mentorship program)
> 

Please add proper commit log for this change.

> Signed-off-by: Danish Prakash <contact@danishpraka.sh>

> ---
>   Documentation/accel/qaic/qaic.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/accel/qaic/qaic.rst b/Documentation/accel/qaic/qaic.rst
> index efb7771273bb..628bf2f7a416 100644
> --- a/Documentation/accel/qaic/qaic.rst
> +++ b/Documentation/accel/qaic/qaic.rst
> @@ -93,7 +93,7 @@ commands (does not impact QAIC).
>   uAPI
>   ====
>   
> -QAIC creates an accel device per phsyical PCIe device. This accel device exists
> +QAIC creates an accel device per physical PCIe device. This accel device exists
>   for as long as the PCIe device is known to Linux.
>   
>   The PCIe device may not be in the state to accept requests from userspace at

thanks,
-- Shuah

Re: [PATCH] Documentation/accel/qaic: Fix typo 'phsyical'

Posted by Jeffrey Hugo 1 year, 8 months ago

On 5/31/2024 8:20 AM, Shuah Khan wrote:
> On 5/31/24 00:09, Danish Prakash wrote:
>> (as part of LFX Linux Mentorship program)
>>
> 
> Please add proper commit log for this change.

Looks like a good fix, and I'd love to take it, but the commit log needs 
some content.

> 
>> Signed-off-by: Danish Prakash <contact@danishpraka.sh>
> 
>> ---
>>   Documentation/accel/qaic/qaic.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/accel/qaic/qaic.rst 
>> b/Documentation/accel/qaic/qaic.rst
>> index efb7771273bb..628bf2f7a416 100644
>> --- a/Documentation/accel/qaic/qaic.rst
>> +++ b/Documentation/accel/qaic/qaic.rst
>> @@ -93,7 +93,7 @@ commands (does not impact QAIC).
>>   uAPI
>>   ====
>> -QAIC creates an accel device per phsyical PCIe device. This accel 
>> device exists
>> +QAIC creates an accel device per physical PCIe device. This accel 
>> device exists
>>   for as long as the PCIe device is known to Linux.
>>   The PCIe device may not be in the state to accept requests from 
>> userspace at
> 
> thanks,
> -- Shuah

[PATCH] Documentation/accel/qaic: Fix typo

Posted by Danish Prakash 1 year, 8 months ago

Fixed a typo in the docs where 'phsyical'
was corrected to 'physical'.

Signed-off-by: Danish Prakash <contact@danishpraka.sh>
---
 Documentation/accel/qaic/qaic.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/accel/qaic/qaic.rst b/Documentation/accel/qaic/qaic.rst
index efb7771273bb..628bf2f7a416 100644
--- a/Documentation/accel/qaic/qaic.rst
+++ b/Documentation/accel/qaic/qaic.rst
@@ -93,7 +93,7 @@ commands (does not impact QAIC).
 uAPI
 ====
 
-QAIC creates an accel device per phsyical PCIe device. This accel device exists
+QAIC creates an accel device per physical PCIe device. This accel device exists
 for as long as the PCIe device is known to Linux.
 
 The PCIe device may not be in the state to accept requests from userspace at
-- 
2.45.1

Re: [PATCH] Documentation/accel/qaic: Fix typo

Posted by Jeffrey Hugo 1 year, 8 months ago

For future reference, since this is the second revision of this change, 
the subject should have "[PATCH v2]".

On 6/1/2024 8:51 AM, Danish Prakash wrote:
> Fixed a typo in the docs where 'phsyical' > was corrected to 'physical'.

Commit text should be in the present simple tense.  You currently are 
using past tense here.  "Fixed" -> "Fix", etc.

> Signed-off-by: Danish Prakash <contact@danishpraka.sh>
> ---

Since this is a single change and not a series, you should have a change 
log here which identifies what is different in this revision.

>   Documentation/accel/qaic/qaic.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/accel/qaic/qaic.rst b/Documentation/accel/qaic/qaic.rst
> index efb7771273bb..628bf2f7a416 100644
> --- a/Documentation/accel/qaic/qaic.rst
> +++ b/Documentation/accel/qaic/qaic.rst
> @@ -93,7 +93,7 @@ commands (does not impact QAIC).
>   uAPI
>   ====
>   
> -QAIC creates an accel device per phsyical PCIe device. This accel device exists
> +QAIC creates an accel device per physical PCIe device. This accel device exists
>   for as long as the PCIe device is known to Linux.
>   
>   The PCIe device may not be in the state to accept requests from userspace at