[PATCH] staging: rtl8723bs: os_dep: Align comments and add a blank line

[PATCH] staging: rtl8723bs: os_dep: Align comments and add a blank line

[Wan Jiabing]

From: Jiabing Wan <kael_w@yeah.net>

Fixing the following checkpatch warnings:
WARNING: Block comments should align the * on each line
WARNING: Missing a blank line after declarations

Signed-off-by: Jiabing Wan<kael_w@yeah.net>
---
 drivers/staging/rtl8723bs/os_dep/osdep_service.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/drivers/staging/rtl8723bs/os_dep/osdep_service.c b/drivers/staging/rtl8723bs/os_dep/osdep_service.c
index c58555a4012f..2d965e62347f 100644
--- a/drivers/staging/rtl8723bs/os_dep/osdep_service.c
+++ b/drivers/staging/rtl8723bs/os_dep/osdep_service.c
@@ -7,10 +7,10 @@
 #include <drv_types.h>
 #include <rtw_debug.h>
 
-/*
-* Translate the OS dependent @param error_code to OS independent RTW_STATUS_CODE
-* @return: one of RTW_STATUS_CODE
-*/
+/**
+ * Translate the OS dependent @param error_code to OS independent RTW_STATUS_CODE
+ * @return: one of RTW_STATUS_CODE
+ */
 inline int RTW_STATUS_CODE(int error_code)
 {
 	if (error_code >= 0)
@@ -262,6 +262,7 @@ bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf)
 void *rtw_cbuf_pop(struct rtw_cbuf *cbuf)
 {
 	void *buf;
+
 	if (rtw_cbuf_empty(cbuf))
 		return NULL;
 
-- 
2.20.1

Re: [PATCH] staging: rtl8723bs: os_dep: Align comments and add a blank line

[Greg Kroah-Hartman]

On Tue, May 18, 2021 at 10:20:54AM +0800, Wan Jiabing wrote:
> From: Jiabing Wan <kael_w@yeah.net>
> 
> Fixing the following checkpatch warnings:
> WARNING: Block comments should align the * on each line
> WARNING: Missing a blank line after declarations
> 
> Signed-off-by: Jiabing Wan<kael_w@yeah.net>
> ---
>  drivers/staging/rtl8723bs/os_dep/osdep_service.c | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/staging/rtl8723bs/os_dep/osdep_service.c b/drivers/staging/rtl8723bs/os_dep/osdep_service.c
> index c58555a4012f..2d965e62347f 100644
> --- a/drivers/staging/rtl8723bs/os_dep/osdep_service.c
> +++ b/drivers/staging/rtl8723bs/os_dep/osdep_service.c
> @@ -7,10 +7,10 @@
>  #include <drv_types.h>
>  #include <rtw_debug.h>
>  
> -/*
> -* Translate the OS dependent @param error_code to OS independent RTW_STATUS_CODE
> -* @return: one of RTW_STATUS_CODE
> -*/
> +/**

If you are going to use kernel doc, make it kernel doc, don't just make
it half-way there :)

> + * Translate the OS dependent @param error_code to OS independent RTW_STATUS_CODE
> + * @return: one of RTW_STATUS_CODE
> + */
>  inline int RTW_STATUS_CODE(int error_code)
>  {
>  	if (error_code >= 0)
> @@ -262,6 +262,7 @@ bool rtw_cbuf_push(struct rtw_cbuf *cbuf, void *buf)
>  void *rtw_cbuf_pop(struct rtw_cbuf *cbuf)
>  {
>  	void *buf;
> +
>  	if (rtw_cbuf_empty(cbuf))
>  		return NULL;
>  
> -- 
> 2.20.1
> 

You are doing multiple things in the same patch, please break this up.

thanks,

greg k-h