linux-kernel - Re: [PATCH] rtl8723bs: Add kernel-doc comment for rtw_reset_continual_io_error in rtw

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <3fe689f9-c434-4c3c-a8cf-0b8ab65153c2@oss.qualcomm.com>
Date: Wed, 17 Dec 2025 07:38:00 -0800
From: Jeff Johnson <jeff.johnson@....qualcomm.com>
To: cjz <guagua210311@...com>, linux-staging@...r.kernel.org
Cc: gregkh@...uxfoundation.org, linux-wireless@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] rtl8723bs: Add kernel-doc comment for
 rtw_reset_continual_io_error in rtw_io.c

On 12/13/2025 10:16 PM, cjz wrote:
> From: changjunzheng <guagua210311@...com>
> 
> 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.