Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:8 as permitted sender) client-ip=2620:137:e000::3:8;
Message-ID: <d4ebae36-265b-4537-ac1b-ae878d236151@amd.com>
Date:   Wed, 25 Oct 2023 10:50:20 -0400
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] drm/atomic: Spelling fix in comments
To:     Kunwu Chan <chentao@kylinos.cn>, daniel@ffwll.ch,
        airlied@gmail.com, tzimmermann@suse.de, mripard@kernel.org,
        maarten.lankhorst@linux.intel.com
Cc:     linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
        kunwu.chan@hotmail.com
References: <20231025082634.34038-1-chentao@kylinos.cn>
Content-Language: en-US
From:   Hamza Mahfooz <hamza.mahfooz@amd.com>
In-Reply-To: <20231025082634.34038-1-chentao@kylinos.cn>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?YlBSQ1FIOUJ0bitNNTZMeHhWMUhSTXpka25DM2FWZ0kvSkM1dWp3NURaUHBu?=
 =?utf-8?B?bHYrTXcrMEFZVnNtQkJ3cisrWXBrM05tcGw0MGJvYWxsQ2VPZ1N6Mm9kMXll?=
 =?utf-8?B?WlovVDRaalJPMllRMlNnSXpKYU9tK0JDZ2NSdncrMEdMNVc2alFCWlhtdGRo?=
 =?utf-8?B?bzE2WDlqTHkrQnJIeTFyZjIyb2NlQ0dLc3lyUFV3VWNEMGtJM1BKRDNKQXBa?=
 =?utf-8?B?U2NYSTRISlBzaDR0cjNlWHYzSzd1aHhzSkwzV1ZHVTI4R1lvWVM5cGZUM3JY?=
 =?utf-8?B?c29CUCt5UTNHTW91ekgvdXBYYTNuUDhnVm1iUjcybUFjRHFvRTBYWXl5cy8r?=
 =?utf-8?B?OVpJMW1qRHhxYmt4ZUhPeWZWdEE3SmpYS3k1aEVwRzNLc1dlTHkzYlBMUWg3?=
 =?utf-8?B?aU1JTDFUcTM2aWRqZkJVT2toZ2FoWU9IbTRPQ3Q2Z1NPcVM0TnI4VGwwTGw3?=
 =?utf-8?B?dGRKK0tQdjdxVnJRWlB5K1g3bk9oR2U2STJNRUxMbXo3WmVDeFRmaHc1WXIr?=
 =?utf-8?B?azVOazRqWUxveGRHanNtVDhSeURDNUhmK3llU0JzbnZpOWgxNFJqZ0IzU09G?=
 =?utf-8?B?b043ckxyckJJYk5BcDlPMGNtS3ZwVEp6ZFBBaFNPMEppU24yK0VzRGJzVmYw?=
 =?utf-8?B?SCtpZHdpT2t0R1NTSFhyLzJGcXhmbzNMRVB3S2k2OWtKdHIzeGN6THlRZkdq?=
 =?utf-8?B?K244MGxPZnU3bVpwa1RyTWw4T2dZV3ZhMzBlcmRNSWQwRTNSekZHeWJYRnJJ?=
 =?utf-8?B?bm1OZENoYmlhZG9EVmxWTWNDMHFyQ2lZTVVrUnp3RUdmRnNTb0grRERWcFc0?=
 =?utf-8?B?Y1BMOEk5c2pTMkxFN0xYWndsL2taM25wTDdKQ2d4b0cyRUxpK0N3QVlOcmQr?=
 =?utf-8?B?anJHYmoyR3kvbEZJZFF3TklKR29kRUwyQ0oxNjBzNXptazB1bzdXUWNuUG5N?=
 =?utf-8?B?WTE5SzN3bkdyQU5PdmV1cFBXazBxc0pmbUc2aUNDRmx2WHZSWmliekZpVFBo?=
 =?utf-8?B?Y3J1NlRQdDdxdjZ3N1lJdlZZOGU4WkVOVFlhNmtoWDZoY1pMZkFMQWtGQXdC?=
 =?utf-8?B?b2Y5S20wRkJrdE5TdEw1bVVVMVVhTGhBRG9qcmRFd2ovVVlGbjdoTHRCc1l0?=
 =?utf-8?B?R0pFQTY2dXluOHk2Y2ZiNHg5eDZzNDQ4cmc4SlR1alFFeTRTa2FidEZ2T2Ns?=
 =?utf-8?B?RmdPVjdYTnBsVWE5L0NYZW9TZzRGamxPR3BHcHluNUo0TWN2TUZ2NEhaU1lG?=
 =?utf-8?B?QmgvSjd2eEU1ek1NcENZYmhXR1VWSWhBaVlwNmFUWGhvTVI1ZVJlVjd3Wk5I?=
 =?utf-8?B?Z3hXakxJNnptMWJFMjRRaDZLSlFMd05jTm5IV3hNNURiamh2ZDFSS1UzaFVX?=
 =?utf-8?B?dXUzQklidmxvRHVWeHd1SS84L1dTTGdCVzBTK1NKS0hsbzg4THBTVWhhTkhS?=
 =?utf-8?B?bVM3SUJOSG5lMjFjV3d6cGxwZWFxOWdTMksxaGdNMEtaelRJUHlTT2tsRGw3?=
 =?utf-8?B?K0VRazVzSXJ0VFFGd3VpTjFrcWVQbkZuNnhNZTBhckxPSk11RWZLeEdhQ09z?=
 =?utf-8?B?SnRHYmtaYXl4ekxHT2tnN3hjMHZPVjVTdnJocUZxdGtkR1h2Wi9teGVJbU8v?=
 =?utf-8?B?TkFYL3owQmZQelZYWG1haVl3OGlsSllRRmZ4U1RvUTFlZUlrOFMwaUZPWWJU?=
 =?utf-8?B?N1RiQjc0TFk4TktwNE4zNWRnbmE2Q09qemtlREJrWkpBOWVBMTdMNzdUKzJz?=
 =?utf-8?B?OTFycm93bCtCSk1ZUUkwc2hxUHFrTDBJemxGaXJVMnFNTE5oekF2NTJoVkE3?=
 =?utf-8?B?czhQMzlVNnJmd2lrVmtjZjUrL2pzL21laG5MclIzaEtGaGwxUUZGeTg3RzhD?=
 =?utf-8?B?dC9aMTNXZE1tU2VzSi9sWVRNeTdVSjdyTG80c3Fzd1NEVkFuc0dkVlNFYkJt?=
 =?utf-8?B?Ny9BVEhRRzdNM1NhNUN6U1hHVUl3UFg1MzQ4ZmwzbjBwMUh0ZUFodE1FTTlO?=
 =?utf-8?B?T1dSaE1aNGNRY2xwYWRuaCtNdDg0Y2YvL0dSTFJFWFVXTjQrOUZnY2liMno1?=
 =?utf-8?B?akd2R3hZNUtnMFZFRWJ3YnpPZi9TelBEdzZHQ3V5d3dWZzA5b2VSZ2l2bWxE?=
 =?utf-8?Q?Zb21q1wPz3nhDsRoNHI/VmpWk?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: d26831c1-a068-4999-3002-08dbd569b7ef
X-MS-Exchange-CrossTenant-AuthSource: DM4PR12MB6280.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Oct 2023 14:50:23.8972
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Fo/YD/pG9l2/WNU19s+O4sMOeRTA2TtYe+jqCukA/u3xOGxfcukSuv2E6QJDX4JQHepHQNweF6KCJh3e4qUXvQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA0PR12MB7556
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Wed, 25 Oct 2023 07:50:49 -0700 (PDT)

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@kylinos.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