[PATCH v3 4/4] staging: rtl8192u: add '*/' on separate line in block comments

Khadija Kamran posted 4 patches 2 years, 10 months ago
[PATCH v3 4/4] staging: rtl8192u: add '*/' on separate line in block comments
Posted by Khadija Kamran 2 years, 10 months ago
Linux kernel coding style uses '*/' on a separate line at the end of
multi line comments.

Fix block comments by moving '*/' at the end of block comments on a
separate line as reported by checkpatch.pl script.

Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
---
 drivers/staging/rtl8192u/r8192U_dm.c | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
index dd9903719c20..cbae852478ea 100644
--- a/drivers/staging/rtl8192u/r8192U_dm.c
+++ b/drivers/staging/rtl8192u/r8192U_dm.c
@@ -244,7 +244,8 @@ void init_rate_adaptive(struct net_device *dev)
  * Output:		NONE
  *
  * Return:		NONE
- *---------------------------------------------------------------------------*/
+ *---------------------------------------------------------------------------
+ */
 static void dm_check_rate_adaptive(struct net_device *dev)
 {
 	struct r8192_priv *priv = ieee80211_priv(dev);
@@ -1525,7 +1526,8 @@ static void dm_bb_initialgain_backup(struct net_device *dev)
  * Output:		NONE
  *
  * Return:		NONE
- *---------------------------------------------------------------------------*/
+ *---------------------------------------------------------------------------
+ */
 static void dm_dig_init(struct net_device *dev)
 {
 	struct r8192_priv *priv = ieee80211_priv(dev);
@@ -1565,7 +1567,8 @@ static void dm_dig_init(struct net_device *dev)
  * Output:		NONE
  *
  * Return:		NONE
- *---------------------------------------------------------------------------*/
+ *---------------------------------------------------------------------------
+ */
 static void dm_ctrl_initgain_byrssi(struct net_device *dev)
 {
 	if (!dm_digtable.dig_enable_flag)
@@ -1751,7 +1754,8 @@ static void dm_ctrl_initgain_byrssi_by_fwfalse_alarm(
  * Output:		NONE
  *
  * Return:		NONE
- *---------------------------------------------------------------------------*/
+ *---------------------------------------------------------------------------
+ */
 static void dm_ctrl_initgain_byrssi_highpwr(
 	struct net_device *dev)
 {
@@ -2137,7 +2141,8 @@ static void dm_ctstoself(struct net_device *dev)
  * Output:		NONE
  *
  * Return:		NONE
- *---------------------------------------------------------------------------*/
+ *---------------------------------------------------------------------------
+ */
 static	void	dm_check_pbc_gpio(struct net_device *dev)
 {
 	struct r8192_priv *priv = ieee80211_priv(dev);
@@ -2166,7 +2171,8 @@ static	void	dm_check_pbc_gpio(struct net_device *dev)
  * Output:		NONE
  *
  * Return:		NONE
- *---------------------------------------------------------------------------*/
+ *---------------------------------------------------------------------------
+ */
 void dm_rf_pathcheck_workitemcallback(struct work_struct *work)
 {
 	struct delayed_work *dwork = to_delayed_work(work);
@@ -2407,7 +2413,8 @@ static void dm_rxpath_sel_byrssi(struct net_device *dev)
  * Output:		NONE
  *
  * Return:		NONE
- *---------------------------------------------------------------------------*/
+ *---------------------------------------------------------------------------
+ */
 static void dm_check_rx_path_selection(struct net_device *dev)
 {
 	struct r8192_priv *priv = ieee80211_priv(dev);
-- 
2.34.1
Re: [PATCH v3 4/4] staging: rtl8192u: add '*/' on separate line in block comments
Posted by Bagas Sanjaya 2 years, 10 months ago
On Tue, Mar 28, 2023 at 12:49:09AM +0500, Khadija Kamran wrote:
> Linux kernel coding style uses '*/' on a separate line at the end of
> multi line comments.
> 
> Fix block comments by moving '*/' at the end of block comments on a
> separate line as reported by checkpatch.pl script.
> 
> Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
> ---
>  drivers/staging/rtl8192u/r8192U_dm.c | 21 ++++++++++++++-------
>  1 file changed, 14 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
> index dd9903719c20..cbae852478ea 100644
> --- a/drivers/staging/rtl8192u/r8192U_dm.c
> +++ b/drivers/staging/rtl8192u/r8192U_dm.c
> @@ -244,7 +244,8 @@ void init_rate_adaptive(struct net_device *dev)
>   * Output:		NONE
>   *
>   * Return:		NONE
> - *---------------------------------------------------------------------------*/
> + *---------------------------------------------------------------------------
> + */
> <snipped>...
>  void dm_rf_pathcheck_workitemcallback(struct work_struct *work)
>  {
>  	struct delayed_work *dwork = to_delayed_work(work);
> @@ -2407,7 +2413,8 @@ static void dm_rxpath_sel_byrssi(struct net_device *dev)
>   * Output:		NONE
>   *
>   * Return:		NONE
> - *---------------------------------------------------------------------------*/
> + *---------------------------------------------------------------------------
> + */

While at above can you please turn these comments above into kernel-doc
comments (see Documentation/doc-guide/kernel-doc.rst for how to write
one)? This requires a placeholder doc where you can write e.g. overview
of the driver and how it is used. The doc should be in
Documentation/driver-api/staging/ (since this is staging driver).

Thanks.

-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH v3 4/4] staging: rtl8192u: add '*/' on separate line in block comments
Posted by Greg KH 2 years, 10 months ago
On Tue, Mar 28, 2023 at 10:27:32AM +0700, Bagas Sanjaya wrote:
> On Tue, Mar 28, 2023 at 12:49:09AM +0500, Khadija Kamran wrote:
> > Linux kernel coding style uses '*/' on a separate line at the end of
> > multi line comments.
> > 
> > Fix block comments by moving '*/' at the end of block comments on a
> > separate line as reported by checkpatch.pl script.
> > 
> > Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
> > ---
> >  drivers/staging/rtl8192u/r8192U_dm.c | 21 ++++++++++++++-------
> >  1 file changed, 14 insertions(+), 7 deletions(-)
> > 
> > diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
> > index dd9903719c20..cbae852478ea 100644
> > --- a/drivers/staging/rtl8192u/r8192U_dm.c
> > +++ b/drivers/staging/rtl8192u/r8192U_dm.c
> > @@ -244,7 +244,8 @@ void init_rate_adaptive(struct net_device *dev)
> >   * Output:		NONE
> >   *
> >   * Return:		NONE
> > - *---------------------------------------------------------------------------*/
> > + *---------------------------------------------------------------------------
> > + */
> > <snipped>...
> >  void dm_rf_pathcheck_workitemcallback(struct work_struct *work)
> >  {
> >  	struct delayed_work *dwork = to_delayed_work(work);
> > @@ -2407,7 +2413,8 @@ static void dm_rxpath_sel_byrssi(struct net_device *dev)
> >   * Output:		NONE
> >   *
> >   * Return:		NONE
> > - *---------------------------------------------------------------------------*/
> > + *---------------------------------------------------------------------------
> > + */
> 
> While at above can you please turn these comments above into kernel-doc
> comments (see Documentation/doc-guide/kernel-doc.rst for how to write
> one)? This requires a placeholder doc where you can write e.g. overview
> of the driver and how it is used. The doc should be in
> Documentation/driver-api/staging/ (since this is staging driver).

No, these are static functions, or just normal internal-to-the-driver
functions, they do not need kerneldoc or any Documentation/* entries,
sorry.

greg k-h
Re: [PATCH v3 4/4] staging: rtl8192u: add '*/' on separate line in block comments
Posted by Bagas Sanjaya 2 years, 10 months ago
On 3/28/23 12:11, Greg KH wrote:
>> While at above can you please turn these comments above into kernel-doc
>> comments (see Documentation/doc-guide/kernel-doc.rst for how to write
>> one)? This requires a placeholder doc where you can write e.g. overview
>> of the driver and how it is used. The doc should be in
>> Documentation/driver-api/staging/ (since this is staging driver).
> 
> No, these are static functions, or just normal internal-to-the-driver
> functions, they do not need kerneldoc or any Documentation/* entries,
> sorry.
> 

Ah! I don't see the context behind the comments, thanks anyway!

-- 
An old man doll... just what I always wanted! - Clara