2024-05-31 06:20:11

by Danish Prakash

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

(as part of LFX Linux Mentorship program)

Signed-off-by: Danish Prakash <[email protected]>
---
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



2024-05-31 14:21:59

by Shuah Khan

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

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 <[email protected]>

> ---
> 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

2024-05-31 21:06:04

by Jeffrey Hugo

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

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 <[email protected]>
>
>> ---
>>   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


2024-06-01 15:00:14

by Danish Prakash

[permalink] [raw]
Subject: [PATCH] Documentation/accel/qaic: Fix typo

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

Signed-off-by: Danish Prakash <[email protected]>
---
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


2024-06-04 16:17:24

by Jeffrey Hugo

[permalink] [raw]
Subject: Re: [PATCH] Documentation/accel/qaic: Fix typo

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 <[email protected]>
> ---

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