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

From: Kunwu Chan
Date: Thu Oct 26 2023 - 22:43:58 EST


Hi Hamza,
Thank you very much for your guidance and advice to me, I have revised it according to your suggestion.

On 2023/10/25 22:50, Hamza Mahfooz wrote:
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@xxxxxxxxxx>
---
  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).