Re: [PATCH] rtl8723bs: Add kernel-doc comment for rtw_reset_continual_io_error in rtw_io.c
From: Jeff Johnson
Date: Wed Dec 17 2025 - 11:01:24 EST
On 12/13/2025 10:16 PM, cjz wrote:
> From: changjunzheng <guagua210311@xxxxxx>
>
> rtw_reset_continual_io_error lacks a standard kernel-doc comment and has an incorrect
> parameter name (dvobjprive vs dvobj) in the existing comment, which causes gcc W=1
> warning and reduces code readability.
>
> This change replaces the non-standard comment with a complete English kernel-doc comment,
> fixes the parameter name error, and keeps all functional logic unchanged.
In addition to Greg's comment, please also review:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
In particular:
Describe your changes in imperative mood, e.g. “make xyzzy do frotz” instead
of “[This patch] makes xyzzy do frotz” or “[I] changed xyzzy to do frotz”, as
if you are giving orders to the codebase to change its behaviour.