Re: [Intel-gfx] [PATCH] GPU: drm: i915: drop unexpected word 'for' in comments

Re: [Intel-gfx] [PATCH] GPU: drm: i915: drop unexpected word 'for' in comments

[Jani Nikula]

On Thu, 23 Jun 2022, Jiang Jian <jiangjian@cdjrlc.com> wrote:
> there is an unexpected word 'for' in the comments that need to be dropped

While it's also unexpected, it's really *duplicated* word.

> file - drivers/gpu/drm/i915/i915_reg.h
> line - 2537
>
>  * Please check the detailed lore in the commit message for for experimental
>
> changed to:
>
>  * Please check the detailed lore in the commit message for experimental
>

The above is just duplication of the patch itself, and completely
unnecessary.

The patch subject prefix should be something like "drm/i915:" or
"drm/i915/reg:".

Pro-tip for figuring out good guesses of what the subject prefix should
be:

$ git log --since={5-year} --no-merges --pretty=format:%s -- drivers/gpu/drm/i915/i915_reg.h | sed 's/:.*//' | sort | uniq -c | sort -rn | head
    312 drm/i915
    113 drm/i915/icl
     57 drm/i915/tgl
     26 drm/i915/cnl
     25 drm/i915/display
     22 drm/i915/dg2
     16 drm/i915/psr
     14 drm/i915/gt
     14 drm/i915/adl_p
     12 drm/i915/dg1

The patch itself is fine, but I'm nitpicking on the commit message
because I've seen lots of patches like this, with the same kind of stuff
in the commit messages.

BR,
Jani.


> Signed-off-by: Jiang Jian <jiangjian@cdjrlc.com>
> ---
>  drivers/gpu/drm/i915/i915_reg.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/i915/i915_reg.h b/drivers/gpu/drm/i915/i915_reg.h
> index 616164fa2e32..738c020396af 100644
> --- a/drivers/gpu/drm/i915/i915_reg.h
> +++ b/drivers/gpu/drm/i915/i915_reg.h
> @@ -2534,7 +2534,7 @@
>   * HDMI/DP bits are g4x+
>   *
>   * WARNING: Bspec for hpd status bits on gen4 seems to be completely confused.
> - * Please check the detailed lore in the commit message for for experimental
> + * Please check the detailed lore in the commit message for experimental
>   * evidence.
>   */
>  /* Bspec says GM45 should match G4X/VLV/CHV, but reality disagrees */

-- 
Jani Nikula, Intel Open Source Graphics Center