Re: [PATCH] drm/i915/uapi: fix doc typos

From: Randy Dunlap
Date: Mon Oct 02 2023 - 03:02:22 EST


Hi--

On 10/1/23 23:47, Ville Syrjälä wrote:
> On Sun, Oct 01, 2023 at 06:08:24PM -0700, Randy Dunlap wrote:
>> Correct typo of "its".
>> Add a comma for clarity.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>> Cc: Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx>
>> Cc: Joonas Lahtinen <joonas.lahtinen@xxxxxxxxxxxxxxx>
>> Cc: Rodrigo Vivi <rodrigo.vivi@xxxxxxxxx>
>> Cc: Tvrtko Ursulin <tvrtko.ursulin@xxxxxxxxxxxxxxx>
>> Cc: intel-gfx@xxxxxxxxxxxxxxxxxxxxx
>> Cc: Maarten Lankhorst <maarten.lankhorst@xxxxxxxxxxxxxxx>
>> Cc: Maxime Ripard <mripard@xxxxxxxxxx>
>> Cc: Thomas Zimmermann <tzimmermann@xxxxxxx>
>> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
>> ---
>> include/uapi/drm/i915_drm.h | 6 +++---
>> 1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff -- a/include/uapi/drm/i915_drm.h b/include/uapi/drm/i915_drm.h
>> --- a/include/uapi/drm/i915_drm.h
>> +++ b/include/uapi/drm/i915_drm.h
>> @@ -38,13 +38,13 @@ extern "C" {
>> */
>>
>> /**
>> - * DOC: uevents generated by i915 on it's device node
>> + * DOC: uevents generated by i915 on its device node
>> *
>> * I915_L3_PARITY_UEVENT - Generated when the driver receives a parity mismatch
>> - * event from the gpu l3 cache. Additional information supplied is ROW,
>> + * event from the GPU l3 cache. Additional information supplied is ROW,
>
> s/l3/L3/ would also be appropriate if aim to fix the caps.

Sure, I can do that.

>
>> * BANK, SUBBANK, SLICE of the affected cacheline. Userspace should keep
>> * track of these events and if a specific cache-line seems to have a
> ^
> I'd put the comma there, but my grasp of English punctuation isn't
> all that great so I might be wrong. Or maybe both places should have
> one?

I don't see a need for a comma there but I'll put one there if you would like it.

>> - * persistent error remap it with the l3 remapping tool supplied in
>> + * persistent error, remap it with the l3 remapping tool supplied in
>> * intel-gpu-tools. The value supplied with the event is always 1.
>> *
>> * I915_ERROR_UEVENT - Generated upon error detection, currently only via
>

Thanks.
--
~Randy