diff mbox series

[29/31] staging: wfx: remove useless comments after #endif

Message ID 20210910160504.1794332-30-Jerome.Pouiller@silabs.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series staging/wfx: usual maintenance | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Jérôme Pouiller Sept. 10, 2021, 4:05 p.m. UTC 
From: Jérôme Pouiller <jerome.pouiller@silabs.com>

Comments after the last #endif of header files don't bring any
information and are redundant with the name of the file. Drop them.

Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com>
---
 drivers/staging/wfx/bh.h      | 2 +-
 drivers/staging/wfx/data_rx.h | 2 +-
 drivers/staging/wfx/data_tx.h | 2 +-
 drivers/staging/wfx/debug.h   | 2 +-
 drivers/staging/wfx/fwio.h    | 2 +-
 drivers/staging/wfx/hwio.h    | 2 +-
 drivers/staging/wfx/key.h     | 2 +-
 drivers/staging/wfx/queue.h   | 2 +-
 drivers/staging/wfx/scan.h    | 2 +-
 drivers/staging/wfx/sta.h     | 2 +-
 drivers/staging/wfx/wfx.h     | 2 +-
 11 files changed, 11 insertions(+), 11 deletions(-)

Comments

Kari Argillander Sept. 10, 2021, 4:27 p.m. UTC | #1 
On Fri, Sep 10, 2021 at 06:05:02PM +0200, Jerome Pouiller wrote:
> From: Jérôme Pouiller <jerome.pouiller@silabs.com>
> 
> Comments after the last #endif of header files don't bring any
> information and are redundant with the name of the file. Drop them.

How so? You see right away that this indeed is header guard and not some
other random thing. Also kernel coding standard says:

	At the end of any non-trivial #if or #ifdef block (more than a
	few line), place a comment after the #endif on the same line,
	noting the conditional expression used.

There is no point dropping them imo. If you think about space saving
this patch will take more space. Because it will be in version history.
So nack from me unless some one can trun my head around.

> 
> Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com>
> ---
>  drivers/staging/wfx/bh.h      | 2 +-
>  drivers/staging/wfx/data_rx.h | 2 +-
>  drivers/staging/wfx/data_tx.h | 2 +-
>  drivers/staging/wfx/debug.h   | 2 +-
>  drivers/staging/wfx/fwio.h    | 2 +-
>  drivers/staging/wfx/hwio.h    | 2 +-
>  drivers/staging/wfx/key.h     | 2 +-
>  drivers/staging/wfx/queue.h   | 2 +-
>  drivers/staging/wfx/scan.h    | 2 +-
>  drivers/staging/wfx/sta.h     | 2 +-
>  drivers/staging/wfx/wfx.h     | 2 +-
>  11 files changed, 11 insertions(+), 11 deletions(-)
> 
> diff --git a/drivers/staging/wfx/bh.h b/drivers/staging/wfx/bh.h
> index f08c62ed039c..6c121ce4dd3f 100644
> --- a/drivers/staging/wfx/bh.h
> +++ b/drivers/staging/wfx/bh.h
> @@ -30,4 +30,4 @@ void wfx_bh_request_rx(struct wfx_dev *wdev);
>  void wfx_bh_request_tx(struct wfx_dev *wdev);
>  void wfx_bh_poll_irq(struct wfx_dev *wdev);
>  
> -#endif /* WFX_BH_H */
> +#endif
> diff --git a/drivers/staging/wfx/data_rx.h b/drivers/staging/wfx/data_rx.h
> index f79545c06130..84d0e3c0507b 100644
> --- a/drivers/staging/wfx/data_rx.h
> +++ b/drivers/staging/wfx/data_rx.h
> @@ -15,4 +15,4 @@ struct hif_ind_rx;
>  void wfx_rx_cb(struct wfx_vif *wvif,
>  	       const struct hif_ind_rx *arg, struct sk_buff *skb);
>  
> -#endif /* WFX_DATA_RX_H */
> +#endif
> diff --git a/drivers/staging/wfx/data_tx.h b/drivers/staging/wfx/data_tx.h
> index dafd8fef44cf..15590a8faefe 100644
> --- a/drivers/staging/wfx/data_tx.h
> +++ b/drivers/staging/wfx/data_tx.h
> @@ -65,4 +65,4 @@ static inline struct hif_req_tx *wfx_skb_txreq(struct sk_buff *skb)
>  	return req;
>  }
>  
> -#endif /* WFX_DATA_TX_H */
> +#endif
> diff --git a/drivers/staging/wfx/debug.h b/drivers/staging/wfx/debug.h
> index 6f2f84d64c9e..4b9c49a9fffb 100644
> --- a/drivers/staging/wfx/debug.h
> +++ b/drivers/staging/wfx/debug.h
> @@ -16,4 +16,4 @@ const char *get_hif_name(unsigned long id);
>  const char *get_mib_name(unsigned long id);
>  const char *get_reg_name(unsigned long id);
>  
> -#endif /* WFX_DEBUG_H */
> +#endif
> diff --git a/drivers/staging/wfx/fwio.h b/drivers/staging/wfx/fwio.h
> index 6028f92503fe..eeea61210eca 100644
> --- a/drivers/staging/wfx/fwio.h
> +++ b/drivers/staging/wfx/fwio.h
> @@ -12,4 +12,4 @@ struct wfx_dev;
>  
>  int wfx_init_device(struct wfx_dev *wdev);
>  
> -#endif /* WFX_FWIO_H */
> +#endif
> diff --git a/drivers/staging/wfx/hwio.h b/drivers/staging/wfx/hwio.h
> index 9a361ed95ecb..ff09575dd1af 100644
> --- a/drivers/staging/wfx/hwio.h
> +++ b/drivers/staging/wfx/hwio.h
> @@ -72,4 +72,4 @@ int control_reg_write_bits(struct wfx_dev *wdev, u32 mask, u32 val);
>  int igpr_reg_read(struct wfx_dev *wdev, int index, u32 *val);
>  int igpr_reg_write(struct wfx_dev *wdev, int index, u32 val);
>  
> -#endif /* WFX_HWIO_H */
> +#endif
> diff --git a/drivers/staging/wfx/key.h b/drivers/staging/wfx/key.h
> index dd189788acf1..2d135eff7af2 100644
> --- a/drivers/staging/wfx/key.h
> +++ b/drivers/staging/wfx/key.h
> @@ -17,4 +17,4 @@ int wfx_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
>  		struct ieee80211_vif *vif, struct ieee80211_sta *sta,
>  		struct ieee80211_key_conf *key);
>  
> -#endif /* WFX_STA_H */
> +#endif
> diff --git a/drivers/staging/wfx/queue.h b/drivers/staging/wfx/queue.h
> index 54b5def2e24c..edd0d018b198 100644
> --- a/drivers/staging/wfx/queue.h
> +++ b/drivers/staging/wfx/queue.h
> @@ -42,4 +42,4 @@ unsigned int wfx_pending_get_pkt_us_delay(struct wfx_dev *wdev,
>  					  struct sk_buff *skb);
>  void wfx_pending_dump_old_frames(struct wfx_dev *wdev, unsigned int limit_ms);
>  
> -#endif /* WFX_QUEUE_H */
> +#endif
> diff --git a/drivers/staging/wfx/scan.h b/drivers/staging/wfx/scan.h
> index 562ca1321daf..78e3b984f375 100644
> --- a/drivers/staging/wfx/scan.h
> +++ b/drivers/staging/wfx/scan.h
> @@ -19,4 +19,4 @@ int wfx_hw_scan(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
>  void wfx_cancel_hw_scan(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
>  void wfx_scan_complete(struct wfx_vif *wvif, int nb_chan_done);
>  
> -#endif /* WFX_SCAN_H */
> +#endif
> diff --git a/drivers/staging/wfx/sta.h b/drivers/staging/wfx/sta.h
> index f359f375cc56..4d7e38be4235 100644
> --- a/drivers/staging/wfx/sta.h
> +++ b/drivers/staging/wfx/sta.h
> @@ -70,4 +70,4 @@ int wfx_update_pm(struct wfx_vif *wvif);
>  void wfx_reset(struct wfx_vif *wvif);
>  u32 wfx_rate_mask_to_hw(struct wfx_dev *wdev, u32 rates);
>  
> -#endif /* WFX_STA_H */
> +#endif
> diff --git a/drivers/staging/wfx/wfx.h b/drivers/staging/wfx/wfx.h
> index a4770f59f7d2..f8df59ad1639 100644
> --- a/drivers/staging/wfx/wfx.h
> +++ b/drivers/staging/wfx/wfx.h
> @@ -161,4 +161,4 @@ static inline int memzcmp(void *src, unsigned int size)
>  	return memcmp(buf, buf + 1, size - 1);
>  }
>  
> -#endif /* WFX_H */
> +#endif
> -- 
> 2.33.0
>
Jérôme Pouiller Sept. 10, 2021, 4:49 p.m. UTC | #2 
On Friday 10 September 2021 18:27:18 CEST Kari Argillander wrote:
> On Fri, Sep 10, 2021 at 06:05:02PM +0200, Jerome Pouiller wrote:
> > From: Jérôme Pouiller <jerome.pouiller@silabs.com>
> >
> > Comments after the last #endif of header files don't bring any
> > information and are redundant with the name of the file. Drop them.
> 
> How so? You see right away that this indeed is header guard and not some
> other random thing. Also kernel coding standard says:
> 
>         At the end of any non-trivial #if or #ifdef block (more than a
>         few line), place a comment after the #endif on the same line,
>         noting the conditional expression used.
> 
> There is no point dropping them imo. If you think about space saving
> this patch will take more space. Because it will be in version history.
> So nack from me unless some one can trun my head around.

IMHO, the #endif on the last line of an header file terminates a trivial
#ifdef block.

Moreover, they are often out-of-sync with the #ifndef statement, like here:

[...]
> > diff --git a/drivers/staging/wfx/key.h b/drivers/staging/wfx/key.h
> > index dd189788acf1..2d135eff7af2 100644
> > --- a/drivers/staging/wfx/key.h
> > +++ b/drivers/staging/wfx/key.h
> > @@ -17,4 +17,4 @@ int wfx_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
> >               struct ieee80211_vif *vif, struct ieee80211_sta *sta,
> >               struct ieee80211_key_conf *key);
> >
> > -#endif /* WFX_STA_H */
> > +#endif
[...]
Kari Argillander Sept. 10, 2021, 5:05 p.m. UTC | #3 
On Fri, Sep 10, 2021 at 06:49:30PM +0200, Jérôme Pouiller wrote:
> On Friday 10 September 2021 18:27:18 CEST Kari Argillander wrote:
> > On Fri, Sep 10, 2021 at 06:05:02PM +0200, Jerome Pouiller wrote:
> > > From: Jérôme Pouiller <jerome.pouiller@silabs.com>
> > >
> > > Comments after the last #endif of header files don't bring any
> > > information and are redundant with the name of the file. Drop them.
> > 
> > How so? You see right away that this indeed is header guard and not some
> > other random thing. Also kernel coding standard says:
> > 
> >         At the end of any non-trivial #if or #ifdef block (more than a
> >         few line), place a comment after the #endif on the same line,
> >         noting the conditional expression used.
> > 
> > There is no point dropping them imo. If you think about space saving
> > this patch will take more space. Because it will be in version history.
> > So nack from me unless some one can trun my head around.
> 
> IMHO, the #endif on the last line of an header file terminates a trivial
> #ifdef block.
> Moreover, they are often out-of-sync with the #ifndef statement, like here:

That one is of course true. 

> 
> [...]
> > > diff --git a/drivers/staging/wfx/key.h b/drivers/staging/wfx/key.h
> > > index dd189788acf1..2d135eff7af2 100644
> > > --- a/drivers/staging/wfx/key.h
> > > +++ b/drivers/staging/wfx/key.h
> > > @@ -17,4 +17,4 @@ int wfx_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
> > >               struct ieee80211_vif *vif, struct ieee80211_sta *sta,
> > >               struct ieee80211_key_conf *key);
> > >
> > > -#endif /* WFX_STA_H */
> > > +#endif
> [...]
> 
> -- 
> Jérôme Pouiller
> 
>
diff mbox series

Patch

diff --git a/drivers/staging/wfx/bh.h b/drivers/staging/wfx/bh.h
index f08c62ed039c..6c121ce4dd3f 100644
--- a/drivers/staging/wfx/bh.h
+++ b/drivers/staging/wfx/bh.h
@@ -30,4 +30,4 @@  void wfx_bh_request_rx(struct wfx_dev *wdev);
 void wfx_bh_request_tx(struct wfx_dev *wdev);
 void wfx_bh_poll_irq(struct wfx_dev *wdev);
 
-#endif /* WFX_BH_H */
+#endif
diff --git a/drivers/staging/wfx/data_rx.h b/drivers/staging/wfx/data_rx.h
index f79545c06130..84d0e3c0507b 100644
--- a/drivers/staging/wfx/data_rx.h
+++ b/drivers/staging/wfx/data_rx.h
@@ -15,4 +15,4 @@  struct hif_ind_rx;
 void wfx_rx_cb(struct wfx_vif *wvif,
 	       const struct hif_ind_rx *arg, struct sk_buff *skb);
 
-#endif /* WFX_DATA_RX_H */
+#endif
diff --git a/drivers/staging/wfx/data_tx.h b/drivers/staging/wfx/data_tx.h
index dafd8fef44cf..15590a8faefe 100644
--- a/drivers/staging/wfx/data_tx.h
+++ b/drivers/staging/wfx/data_tx.h
@@ -65,4 +65,4 @@  static inline struct hif_req_tx *wfx_skb_txreq(struct sk_buff *skb)
 	return req;
 }
 
-#endif /* WFX_DATA_TX_H */
+#endif
diff --git a/drivers/staging/wfx/debug.h b/drivers/staging/wfx/debug.h
index 6f2f84d64c9e..4b9c49a9fffb 100644
--- a/drivers/staging/wfx/debug.h
+++ b/drivers/staging/wfx/debug.h
@@ -16,4 +16,4 @@  const char *get_hif_name(unsigned long id);
 const char *get_mib_name(unsigned long id);
 const char *get_reg_name(unsigned long id);
 
-#endif /* WFX_DEBUG_H */
+#endif
diff --git a/drivers/staging/wfx/fwio.h b/drivers/staging/wfx/fwio.h
index 6028f92503fe..eeea61210eca 100644
--- a/drivers/staging/wfx/fwio.h
+++ b/drivers/staging/wfx/fwio.h
@@ -12,4 +12,4 @@  struct wfx_dev;
 
 int wfx_init_device(struct wfx_dev *wdev);
 
-#endif /* WFX_FWIO_H */
+#endif
diff --git a/drivers/staging/wfx/hwio.h b/drivers/staging/wfx/hwio.h
index 9a361ed95ecb..ff09575dd1af 100644
--- a/drivers/staging/wfx/hwio.h
+++ b/drivers/staging/wfx/hwio.h
@@ -72,4 +72,4 @@  int control_reg_write_bits(struct wfx_dev *wdev, u32 mask, u32 val);
 int igpr_reg_read(struct wfx_dev *wdev, int index, u32 *val);
 int igpr_reg_write(struct wfx_dev *wdev, int index, u32 val);
 
-#endif /* WFX_HWIO_H */
+#endif
diff --git a/drivers/staging/wfx/key.h b/drivers/staging/wfx/key.h
index dd189788acf1..2d135eff7af2 100644
--- a/drivers/staging/wfx/key.h
+++ b/drivers/staging/wfx/key.h
@@ -17,4 +17,4 @@  int wfx_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
 		struct ieee80211_vif *vif, struct ieee80211_sta *sta,
 		struct ieee80211_key_conf *key);
 
-#endif /* WFX_STA_H */
+#endif
diff --git a/drivers/staging/wfx/queue.h b/drivers/staging/wfx/queue.h
index 54b5def2e24c..edd0d018b198 100644
--- a/drivers/staging/wfx/queue.h
+++ b/drivers/staging/wfx/queue.h
@@ -42,4 +42,4 @@  unsigned int wfx_pending_get_pkt_us_delay(struct wfx_dev *wdev,
 					  struct sk_buff *skb);
 void wfx_pending_dump_old_frames(struct wfx_dev *wdev, unsigned int limit_ms);
 
-#endif /* WFX_QUEUE_H */
+#endif
diff --git a/drivers/staging/wfx/scan.h b/drivers/staging/wfx/scan.h
index 562ca1321daf..78e3b984f375 100644
--- a/drivers/staging/wfx/scan.h
+++ b/drivers/staging/wfx/scan.h
@@ -19,4 +19,4 @@  int wfx_hw_scan(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
 void wfx_cancel_hw_scan(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
 void wfx_scan_complete(struct wfx_vif *wvif, int nb_chan_done);
 
-#endif /* WFX_SCAN_H */
+#endif
diff --git a/drivers/staging/wfx/sta.h b/drivers/staging/wfx/sta.h
index f359f375cc56..4d7e38be4235 100644
--- a/drivers/staging/wfx/sta.h
+++ b/drivers/staging/wfx/sta.h
@@ -70,4 +70,4 @@  int wfx_update_pm(struct wfx_vif *wvif);
 void wfx_reset(struct wfx_vif *wvif);
 u32 wfx_rate_mask_to_hw(struct wfx_dev *wdev, u32 rates);
 
-#endif /* WFX_STA_H */
+#endif
diff --git a/drivers/staging/wfx/wfx.h b/drivers/staging/wfx/wfx.h
index a4770f59f7d2..f8df59ad1639 100644
--- a/drivers/staging/wfx/wfx.h
+++ b/drivers/staging/wfx/wfx.h
@@ -161,4 +161,4 @@  static inline int memzcmp(void *src, unsigned int size)
 	return memcmp(buf, buf + 1, size - 1);
 }
 
-#endif /* WFX_H */
+#endif