[PATCH 8455/8455] staging: rtl8188eu: core: fixed a comment format issue.

[PATCH 8455/8455] staging: rtl8188eu: core: fixed a comment format issue.

[Daniel West]

Fixed a checkpatch warning:

WARNING: Block comments use * on subsequent lines
 #4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:
+/****************************************************************************
+

The code is full of comments like this. Should the coding style
be inforced here, even when there is a logic to the way the code
was broken up?

Signed-off-by: Daniel West <daniel.west.dev@gmail.com>
---
 drivers/staging/rtl8188eu/core/rtw_mlme_ext.c | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c b/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c
index 8794907a39f4..adf2788a416f 100644
--- a/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c
+++ b/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c
@@ -4591,11 +4591,10 @@ void mlmeext_sta_del_event_callback(struct adapter *padapter)
 	}
 }
 
-/****************************************************************************
-
-Following are the functions for the timer handlers
-
-*****************************************************************************/
+/*
+ *
+ *Following are the functions for the timer handlers
+ */
 
 static u8 chk_ap_is_alive(struct adapter *padapter, struct sta_info *psta)
 {
-- 
2.25.1

Re: [PATCH 8455/8455] staging: rtl8188eu: core: fixed a comment format issue.

[Kari Argillander]

On Sat, Dec 19, 2020 at 02:43:12PM -0800, Daniel West wrote:
> Fixed a checkpatch warning:
> 
> WARNING: Block comments use * on subsequent lines
>  #4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:
> +/****************************************************************************
> +
> 
> The code is full of comments like this. Should the coding style
> be inforced here, even when there is a logic to the way the code
> was broken up?

You should make one patch which atleast fix one file at ones. It would
be even better if it fixes whole stuff (example one driver) right a way.
Also note that you should not but this kind messages to your patch
message. If you want to note this kind of thing you can use --- and
after that it will not included in patch itself. You can read it online
more.

Also where does this [PATCH 8455/8455] even come from? Good thing is
that you really didn't send so many patches or atleast I won't see them.

And it seems that you are new so welcome a board :)

--
Kari Argillander

Re: [PATCH 8455/8455] staging: rtl8188eu: core: fixed a comment format issue.

[Greg KH]

On Sat, Dec 19, 2020 at 02:43:12PM -0800, Daniel West wrote:
> Fixed a checkpatch warning:
> 
> WARNING: Block comments use * on subsequent lines
>  #4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:
> +/****************************************************************************
> +
> 
> The code is full of comments like this. Should the coding style
> be inforced here, even when there is a logic to the way the code
> was broken up?
> 
> Signed-off-by: Daniel West <daniel.west.dev@gmail.com>
> ---
>  drivers/staging/rtl8188eu/core/rtw_mlme_ext.c | 9 ++++-----
>  1 file changed, 4 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c b/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c
> index 8794907a39f4..adf2788a416f 100644
> --- a/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c
> +++ b/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c
> @@ -4591,11 +4591,10 @@ void mlmeext_sta_del_event_callback(struct adapter *padapter)
>  	}
>  }
>  
> -/****************************************************************************
> -
> -Following are the functions for the timer handlers
> -
> -*****************************************************************************/
> +/*
> + *
> + *Following are the functions for the timer handlers
> + */

Does that look correct?  Make it all one line please.

thanks,

greg k-h

Re: [PATCH 8455/8455] staging: rtl8188eu: core: fixed a comment format issue.

[Joe Perches]

On Mon, 2020-12-28 at 15:09 +0100, Greg KH wrote:
> On Sat, Dec 19, 2020 at 02:43:12PM -0800, Daniel West wrote:
> > Fixed a checkpatch warning:
> > 
> > WARNING: Block comments use * on subsequent lines
> >  #4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:
> > +/****************************************************************************
> > +
> > 
> > The code is full of comments like this. Should the coding style
> > be inforced here, even when there is a logic to the way the code
> > was broken up?
[]
> > diff --git a/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c b/drivers/staging/rtl8188eu/core/rtw_mlme_ext.c
[]
> > @@ -4591,11 +4591,10 @@ void mlmeext_sta_del_event_callback(struct adapter *padapter)
> >  	}
> >  }
> >  
> > 
> > -/****************************************************************************
> > -
> > -Following are the functions for the timer handlers
> > -
> > -*****************************************************************************/
> > +/*
> > + *
> > + *Following are the functions for the timer handlers
> > + */
> 
> Does that look correct?  Make it all one line please.

Just:

/* timer handler functions */

would be simpler.

And the code is mostly a horror to read.