[PATCH 2/3] staging: rtl8192u: remove change history from comments

Khadija Kamran posted 3 patches 2 years, 10 months ago
There is a newer version of this series
[PATCH 2/3] staging: rtl8192u: remove change history from comments
Posted by Khadija Kamran 2 years, 10 months ago
Developers use git to browse the file history so revision history is not
required in the comments.
Remove the change history information from the comments.

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

diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
index a88686be3523..885c5966342f 100644
--- a/drivers/staging/rtl8192u/r8192U_dm.c
+++ b/drivers/staging/rtl8192u/r8192U_dm.c
@@ -8,11 +8,6 @@
  * Abstract:
  *	HW dynamic mechanism.
  *
- * Major Change History:
- *	When		Who				What
- *	----------	--------------- -------------------------------
- *	2008-05-14	amy                     create version 0 porting from windows code.
- *
  *--
  */
 #include "r8192U.h"
@@ -276,10 +271,6 @@ void init_rate_adaptive(struct net_device *dev)
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	05/26/08	amy	Create version 0 porting from windows code.
- *
  *---------------------------------------------------------------------------
  */
 static void dm_check_rate_adaptive(struct net_device *dev)
@@ -1594,10 +1585,6 @@ static void dm_bb_initialgain_backup(struct net_device *dev)
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	05/15/2008	amy		Create Version 0 porting from windows code.
- *
  *---------------------------------------------------------------------------
  */
 static void dm_dig_init(struct net_device *dev)
@@ -1640,9 +1627,6 @@ static void dm_dig_init(struct net_device *dev)
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	05/27/2008	amy		Create Version 0 porting from windows code.
  *---------------------------------------------------------------------------
  */
 static void dm_ctrl_initgain_byrssi(struct net_device *dev)
@@ -1857,10 +1841,6 @@ static void dm_ctrl_initgain_byrssi_by_fwfalse_alarm(
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	05/28/2008	amy		Create Version 0 porting from windows code.
- *
  *---------------------------------------------------------------------------
  */
 static void dm_ctrl_initgain_byrssi_highpwr(
@@ -2277,10 +2257,6 @@ static void dm_ctstoself(struct net_device *dev)
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	05/28/2008	amy	Create Version 0 porting from windows code.
- *
  *---------------------------------------------------------------------------
  */
 static	void	dm_check_pbc_gpio(struct net_device *dev)
@@ -2312,10 +2288,6 @@ static	void	dm_check_pbc_gpio(struct net_device *dev)
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	01/30/2008	MHC		Create Version 0.
- *
  *---------------------------------------------------------------------------
  */
 void dm_rf_pathcheck_workitemcallback(struct work_struct *work)
@@ -2562,10 +2534,6 @@ static void dm_rxpath_sel_byrssi(struct net_device *dev)
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	05/28/2008	amy		Create Version 0 porting from windows code.
- *
  *---------------------------------------------------------------------------
  */
 static void dm_check_rx_path_selection(struct net_device *dev)
@@ -2882,10 +2850,6 @@ void dm_check_fsync(struct net_device *dev)
  *
  * Return:		NONE
  *
- * Revised History:
- *	When		Who		Remark
- *	03/06/2008	Jacken	Create Version 0.
- *
  *---------------------------------------------------------------------------
  */
 static void dm_init_dynamic_txpower(struct net_device *dev)
-- 
2.34.1
Re: [PATCH 2/3] staging: rtl8192u: remove change history from comments
Posted by Greg KH 2 years, 10 months ago
On Sat, Mar 25, 2023 at 05:13:17PM +0500, Khadija Kamran wrote:
> Developers use git to browse the file history so revision history is not
> required in the comments.
> Remove the change history information from the comments.
> 
> Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
> ---
>  drivers/staging/rtl8192u/r8192U_dm.c | 36 ----------------------------
>  1 file changed, 36 deletions(-)
> 
> diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
> index a88686be3523..885c5966342f 100644
> --- a/drivers/staging/rtl8192u/r8192U_dm.c
> +++ b/drivers/staging/rtl8192u/r8192U_dm.c
> @@ -8,11 +8,6 @@
>   * Abstract:
>   *	HW dynamic mechanism.
>   *
> - * Major Change History:
> - *	When		Who				What
> - *	----------	--------------- -------------------------------
> - *	2008-05-14	amy                     create version 0 porting from windows code.
> - *
>   *--
>   */
>  #include "r8192U.h"
> @@ -276,10 +271,6 @@ void init_rate_adaptive(struct net_device *dev)
>   *
>   * Return:		NONE
>   *
> - * Revised History:
> - *	When		Who		Remark
> - *	05/26/08	amy	Create version 0 porting from windows code.
> - *
>   *---------------------------------------------------------------------------

You can remove the extra blank comment line as well.

thanks,

greg k-h
Re: [PATCH 2/3] staging: rtl8192u: remove change history from comments
Posted by Julia Lawall 2 years, 10 months ago

On Sat, 25 Mar 2023, Greg KH wrote:

> On Sat, Mar 25, 2023 at 05:13:17PM +0500, Khadija Kamran wrote:
> > Developers use git to browse the file history so revision history is not
> > required in the comments.
> > Remove the change history information from the comments.

I'm not sure to follow the argument.  The file was integrated into the
Linux kernel in 2009.  So there is no record of the 2008 date in the git
history of the Linux kernel.  Maybe it's not interesting, but at least the
explanation doesn't seem right.

julia

> >
> > Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
> > ---
> >  drivers/staging/rtl8192u/r8192U_dm.c | 36 ----------------------------
> >  1 file changed, 36 deletions(-)
> >
> > diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
> > index a88686be3523..885c5966342f 100644
> > --- a/drivers/staging/rtl8192u/r8192U_dm.c
> > +++ b/drivers/staging/rtl8192u/r8192U_dm.c
> > @@ -8,11 +8,6 @@
> >   * Abstract:
> >   *	HW dynamic mechanism.
> >   *
> > - * Major Change History:
> > - *	When		Who				What
> > - *	----------	--------------- -------------------------------
> > - *	2008-05-14	amy                     create version 0 porting from windows code.
> > - *
> >   *--
> >   */
> >  #include "r8192U.h"
> > @@ -276,10 +271,6 @@ void init_rate_adaptive(struct net_device *dev)
> >   *
> >   * Return:		NONE
> >   *
> > - * Revised History:
> > - *	When		Who		Remark
> > - *	05/26/08	amy	Create version 0 porting from windows code.
> > - *
> >   *---------------------------------------------------------------------------
>
> You can remove the extra blank comment line as well.
>
> thanks,
>
> greg k-h
>
>