[v2] drm/i915/uapi: fix doc typos

Message ID 20231008214942.28439-1-rdunlap@infradead.org
State New
Headers
Series [v2] drm/i915/uapi: fix doc typos |

Commit Message

Randy Dunlap Oct. 8, 2023, 9:49 p.m. UTC
  Correct typo of "its".
Add commas for clarity.
Capitalize L3.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>
Cc: intel-gfx@lists.freedesktop.org
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Cc: dri-devel@lists.freedesktop.org
---
v2: capitalize L3, add another comma for clarity (Ville)

 include/uapi/drm/i915_drm.h |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
  

Comments

Rodrigo Vivi Oct. 9, 2023, 4:38 p.m. UTC | #1
On Sun, Oct 08, 2023 at 02:49:40PM -0700, Randy Dunlap wrote:
> Correct typo of "its".
> Add commas for clarity.
> Capitalize L3.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jani Nikula <jani.nikula@linux.intel.com>
> Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
> Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
> Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>
> Cc: intel-gfx@lists.freedesktop.org
> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> Cc: Maxime Ripard <mripard@kernel.org>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
> Cc: dri-devel@lists.freedesktop.org

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

and pushed, thanks for the patch

> ---
> v2: capitalize L3, add another comma for clarity (Ville)
> 
>  include/uapi/drm/i915_drm.h |    8 ++++----
>  1 file changed, 4 insertions(+), 4 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,
>   *	BANK, SUBBANK, SLICE of the affected cacheline. Userspace should keep
> - *	track of these events and if a specific cache-line seems to have a
> - *	persistent error remap it with the l3 remapping tool supplied in
> + *	track of these events, and if a specific cache-line seems to have a
> + *	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
  

Patch

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,
  *	BANK, SUBBANK, SLICE of the affected cacheline. Userspace should keep
- *	track of these events and if a specific cache-line seems to have a
- *	persistent error remap it with the l3 remapping tool supplied in
+ *	track of these events, and if a specific cache-line seems to have a
+ *	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