linux-kernel - Re: [PATCH] drm/atomic: Spelling fix in comments

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <d4ebae36-265b-4537-ac1b-ae878d236151@amd.com>
Date:   Wed, 25 Oct 2023 10:50:20 -0400
From:   Hamza Mahfooz <hamza.mahfooz@....com>
To:     Kunwu Chan <chentao@...inos.cn>, daniel@...ll.ch,
        airlied@...il.com, tzimmermann@...e.de, mripard@...nel.org,
        maarten.lankhorst@...ux.intel.com
Cc:     linux-kernel@...r.kernel.org, dri-devel@...ts.freedesktop.org,
        kunwu.chan@...mail.com
Subject: Re: [PATCH] drm/atomic: Spelling fix in comments

Hi Kunwu,

Can you make the tagline something along the lines of `drm/atomic
helper: fix spelling mistake "preceeding" -> "preceding"`, in general to
determine an appropriate prefix, you can see what previous commits used
when making changes to files in your particular patch, e.g. using the
following:

$ git log drivers/gpu/drm/drm_atomic_helper.c
On 10/25/23 04:26, Kunwu Chan wrote:
> fix a typo in a comments.

For patch descriptions you should try to more descriptive.

So, something like "There is a spelling mistake in 

drm_atomic_helper_wait_for_dependencies()'s kernel doc. Fix it." would
be better.

> 
> Signed-off-by: Kunwu Chan <chentao@...inos.cn>
> ---
>   drivers/gpu/drm/drm_atomic_helper.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_atomic_helper.c b/drivers/gpu/drm/drm_atomic_helper.c
> index 2444fc33dd7c..c3f677130def 100644
> --- a/drivers/gpu/drm/drm_atomic_helper.c
> +++ b/drivers/gpu/drm/drm_atomic_helper.c
> @@ -2382,10 +2382,10 @@ int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
>   EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
>   
>   /**
> - * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
> + * drm_atomic_helper_wait_for_dependencies - wait for required preceding commits
>    * @old_state: atomic state object with old state structures
>    *
> - * This function waits for all preceeding commits that touch the same CRTC as
> + * This function waits for all preceding commits that touch the same CRTC as
>    * @old_state to both be committed to the hardware (as signalled by
>    * drm_atomic_helper_commit_hw_done()) and executed by the hardware (as signalled
>    * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
-- 
Hamza