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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <a7b30487-21db-45ae-bb49-596971c32b25@infradead.org>
Date:   Mon, 2 Oct 2023 00:02:18 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Ville Syrjälä <ville.syrjala@...ux.intel.com>
Cc:     linux-kernel@...r.kernel.org,
        Tvrtko Ursulin <tvrtko.ursulin@...ux.intel.com>,
        dri-devel@...ts.freedesktop.org, intel-gfx@...ts.freedesktop.org,
        Maxime Ripard <mripard@...nel.org>,
        Thomas Zimmermann <tzimmermann@...e.de>,
        Rodrigo Vivi <rodrigo.vivi@...el.com>
Subject: Re: [PATCH] drm/i915/uapi: fix doc typos

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@...radead.org>
>> Cc: Jani Nikula <jani.nikula@...ux.intel.com>
>> Cc: Joonas Lahtinen <joonas.lahtinen@...ux.intel.com>
>> Cc: Rodrigo Vivi <rodrigo.vivi@...el.com>
>> Cc: Tvrtko Ursulin <tvrtko.ursulin@...ux.intel.com>
>> Cc: intel-gfx@...ts.freedesktop.org
>> Cc: Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>
>> Cc: Maxime Ripard <mripard@...nel.org>
>> Cc: Thomas Zimmermann <tzimmermann@...e.de>
>> Cc: dri-devel@...ts.freedesktop.org
>> ---
>>  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