Skip to contentSkip to conversation

fix several minor description typos

PATCH In review Walter Goldens 2 participants 3 messages May 17, 2010 – May 18, 2010

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 fix several minor description typos

---

drivers/net/wireless/ath/ath5k/eeprom.c +1 -1
@@ -715,7 +715,7 @@ ath5k_eeprom_convert_pcal_info_5111(stru
 
         /* Only one curve for RF5111
          * find out which one and place
-         * in in pd_curves.
+         * in pd_curves.
          * Note: ee_x_gain is reversed here */
         for (idx = 0; idx < AR5K_EEPROM_N_PD_CURVES; idx++) {
 
drivers/net/wireless/ath/ath9k/hw.h +1 -1
@@ -459,7 +459,7 @@ struct ath9k_hw_version {
 #define AR_GENTMR_BIT(_index)    (1 << (_index))
 
 /*
- * Using de Bruijin sequence to to look up 1's index in a 32 bit number
+ * Using de Bruijin sequence to look up 1's index in a 32 bit number

  * debruijn32 = 0000 0111 0111 1100 1011 0101 0011 0001 */
#define debruijn32 0x077CB531U

drivers/net/wireless/iwmc3200wifi/hal.c +0 -0
@@ -54,7 +54,7 @@

  *   LMAC. If you look at LMAC commands you'll se that they *   are actually regular iwlwifi target commands encapsulated *   into a special UMAC command called UMAC passthrough.
- *   This is due to the fact the the host talks exclusively
+ *   This is due to the fact the host talks exclusively *   to the UMAC and so there needs to be a special UMAC *   command for talking to the LMAC.
  *   This is how a wifi command is layed out:

drivers/net/wireless/libertas/scan.c +0 -0
@@ -666,7 +666,7 @@ void lbs_scan_worker(struct work_struct 
 /**

  *  @brief Interpret a BSS scan response returned from the firmware *
- *  Parse the various fixed fields and IEs passed back for a a BSS probe
+ *  Parse the various fixed fields and IEs passed back for a BSS probe *  response or beacon from the scan command.  Record information as needed *  in the scan table struct bss_descriptor for that entry.
  *

drivers/net/wireless/orinoco/hermes_dld.c +1 -1
@@ -68,7 +68,7 @@ struct dblock {
 } __attribute__ ((packed));
 
 /*
- * Plug Data References are located in in the image after the last data
+ * Plug Data References are located in the image after the last data

  * block.  They refer to areas in the adapter memory where the plug data
  * items with matching ID should be written.
  */

drivers/net/wireless/orinoco/main.h +1 -1
@@ -12,7 +12,7 @@
 /* Compile time configuration and compatibility stuff               */
 /********************************************************************/
 
-/* We do this this way to avoid ifdefs in the actual code */
+/* We do that this way to avoid ifdefs in the actual code */
 #ifdef WIRELESS_SPY
 #define SPY_NUMBER(priv)    (priv->spy_data.spy_number)
 #else
drivers/net/wireless/rt2x00/rt2x00dev.c +1 -1
@@ -224,7 +224,7 @@ void rt2x00lib_txdone(struct queue_entry
     /*
      * If the IV/EIV data was stripped from the frame before it was
      * passed to the hardware, we should now reinsert it again because
-     * mac80211 will expect the the same data to be present it the
+     * mac80211 will expect the same data to be present it the
      * frame as it was passed to us.
      */
     if (test_bit(CONFIG_SUPPORT_HW_CRYPTO, &rt2x00dev->flags))
drivers/net/wireless/zd1211rw/zd_mac.c +1 -1
@@ -855,7 +855,7 @@ int zd_mac_rx(struct ieee80211_hw *hw, c
     if (skb == NULL)
         return -ENOMEM;
     if (need_padding) {
-        /* Make sure the the payload data is 4 byte aligned. */
+        /* Make sure the payload data is 4 byte aligned. */
         skb_reserve(skb, 2);
     }
 
drivers/net/wireless/zd1211rw/zd_usb.c +0 -0
@@ -844,7 +844,7 @@ out:

  * @usb: a &struct zd_usb pointer
  * @urb: URB to be freed
  *
- * Frees the the transmission URB, which means to put it on the free URB
+ * Frees the transmission URB, which means to put it on the free URB
  * list.
  */
static void free_tx_urb(struct zd_usb *usb, struct urb *urb)

include/linux/ieee80211.h +1 -1
@@ -302,7 +302,7 @@ static inline int ieee80211_is_data_qos(
 static inline int ieee80211_is_data_present(__le16 fc)
 {
     /*
-     * mask with 0x40 and test that that bit is clear to only return true
+     * mask with 0x40 and test that this bit is clear to only return true
      * for the data-containing substypes.
      */
     return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | 0x40)) ==
include/linux/nl80211.h +0 -0
@@ -132,7 +132,7 @@

  *     %NL80211_ATTR_REG_RULE_POWER_MAX_ANT_GAIN and
  *     %NL80211_ATTR_REG_RULE_POWER_MAX_EIRP.
  * @NL80211_CMD_REQ_SET_REG: ask the wireless core to set the regulatory domain
- *     to the the specified ISO/IEC 3166-1 alpha2 country code. The core will
+ *     to the specified ISO/IEC 3166-1 alpha2 country code. The core will
  *     store this as a valid request and then query userspace for it. *
  * @NL80211_CMD_GET_MESH_PARAMS: Get mesh networking properties for the

include/net/cfg80211.h +0 -0
@@ -90,7 +90,7 @@ enum ieee80211_channel_flags {

  * @max_power: maximum transmission power (in dBm)
  * @beacon_found: helper to regulatory code to indicate when a beacon *    has been found on this channel. Use regulatory_hint_found_beacon()
- *    to enable this, this is is useful only on 5 GHz band.
+ *    to enable this, this is useful only on 5 GHz band.
  * @orig_mag: internal use
  * @orig_mpwr: internal use
  */

net/mac80211/mlme.c +1 -1
@@ -1767,7 +1767,7 @@ static void ieee80211_sta_work(struct wo
 
     /*
      * ieee80211_queue_work() should have picked up most cases,
-     * here we'll pick the the rest.
+     * here we'll pick the rest.
      */
     if (WARN(local->suspended, "STA MLME work scheduled while "
          "going to suspend\n"))
net/mac80211/status.c +1 -1
@@ -47,7 +47,7 @@ static void ieee80211_handle_filtered_fr
     /*
      * This skb 'survived' a round-trip through the driver, and
      * hopefully the driver didn't mangle it too badly. However,
-     * we can definitely not rely on the the control information
+     * we can definitely not rely on the control information
      * being correct. Clear it so we don't get junk there, and
      * indicate that it needs new processing, but must not be
      * modified/encrypted again.
net/mac80211/work.c +1 -1
@@ -840,7 +840,7 @@ static void ieee80211_work_work(struct w
 
     /*
      * ieee80211_queue_work() should have picked up most cases,
-     * here we'll pick the the rest.
+     * here we'll pick the rest.
      */
     if (WARN(local->suspended, "work scheduled while going to suspend\n"))
         return;
#1 lore raw

You may want to prefix the patch title with 'wireless:', and include in the commitlog a description what type of errors you are correcting. In this case I'd guess 'avoid word repetition'.

Most of the changes seem obviously correct. However a couple:

drivers/net/wireless/orinoco/main.h line 18

Quoted 11 lines · Walter Goldens
drivers/net/wireless/orinoco/main.h +1 -1
@@ -12,7 +12,7 @@
 /* Compile time configuration and compatibility stuff               */
 /********************************************************************/
 
-/* We do this this way to avoid ifdefs in the actual code */
+/* We do that this way to avoid ifdefs in the actual code */
 #ifdef WIRELESS_SPY
 #define SPY_NUMBER(priv)    (priv->spy_data.spy_number)
 #else

The latter construction doesn't make sense (to me). The former does, even if it is a little clumsy. If the comment is still useful, I suggest rewording it as something like:

/* Define SPY_NUMBER like this to avoid ifdefs in the actual code */

include/linux/ieee80211.h static inline int ieee80211_is_data_qos( · line 308

Quoted 11 lines
include/linux/ieee80211.h +1 -1
@@ -302,7 +302,7 @@ static inline int ieee80211_is_data_qos(
 static inline int ieee80211_is_data_present(__le16 fc)
 {
     /*
-     * mask with 0x40 and test that that bit is clear to only return true
+     * mask with 0x40 and test that this bit is clear to only return true
      * for the data-containing substypes.
      */
     return (fc & cpu_to_le16(IEEE80211_FCTL_FTYPE | 0x40)) ==

You may also want to correct the spelling of 'subtypes' here. I also think that this could be reworded better. After consulting IEE802.11-2007, section 7.1.3.1.2, I'd suggest:

/* Only return true for the data-containing subtypes.
* Bit 0x40 indicates the frame subtype does not contain a Frame Body
* field (i.e. there is no data). This bit should not be set. */

But I'd confirm with one of the core wireless developers before making that change. It may also be worth changing the code to use IEEE80211_STYPE_NULLFUNC instead of 0x40.

Regards,

Dave.

#2 lore raw

PATCH 1/1 wireless: fix several minor description typos

Dave,

Thanks for point my missteps. I did think about leaving the code you quoted intact, so basically I've omitted it with this version. After all, the patch is inessential to the code execution.

---
avoid word repetition

drivers/net/wireless/ath/ath5k/eeprom.c +1 -1
@@ -715,7 +715,7 @@ ath5k_eeprom_convert_pcal_info_5111(stru
 
 		/* Only one curve for RF5111
 		 * find out which one and place
-		 * in in pd_curves.
+		 * in pd_curves.
 		 * Note: ee_x_gain is reversed here */
 		for (idx = 0; idx < AR5K_EEPROM_N_PD_CURVES; idx++) {
 
drivers/net/wireless/ath/ath9k/hw.h +1 -1
@@ -459,7 +459,7 @@ struct ath9k_hw_version {
 #define AR_GENTMR_BIT(_index)	(1 << (_index))
 
 /*
- * Using de Bruijin sequence to to look up 1's index in a 32 bit number
+ * Using de Bruijin sequence to look up 1's index in a 32 bit number
  * debruijn32 = 0000 0111 0111 1100 1011 0101 0011 0001
  */
 #define debruijn32 0x077CB531U
drivers/net/wireless/iwmc3200wifi/hal.c +1 -1
@@ -54,7 +54,7 @@
  *   LMAC. If you look at LMAC commands you'll se that they
  *   are actually regular iwlwifi target commands encapsulated
  *   into a special UMAC command called UMAC passthrough.
- *   This is due to the fact the the host talks exclusively
+ *   This is due to the fact the host talks exclusively
  *   to the UMAC and so there needs to be a special UMAC
  *   command for talking to the LMAC.
  *   This is how a wifi command is layed out:
drivers/net/wireless/libertas/scan.c +1 -1
@@ -666,7 +666,7 @@ void lbs_scan_worker(struct work_struct 
 /**
  *  @brief Interpret a BSS scan response returned from the firmware
  *
- *  Parse the various fixed fields and IEs passed back for a a BSS probe
+ *  Parse the various fixed fields and IEs passed back for a BSS probe
  *  response or beacon from the scan command.  Record information as needed
  *  in the scan table struct bss_descriptor for that entry.
  *
drivers/net/wireless/orinoco/hermes_dld.c +1 -1
@@ -68,7 +68,7 @@ struct dblock {
 } __attribute__ ((packed));
 
 /*
- * Plug Data References are located in in the image after the last data
+ * Plug Data References are located in the image after the last data
  * block.  They refer to areas in the adapter memory where the plug data
  * items with matching ID should be written.
  */
drivers/net/wireless/rt2x00/rt2x00dev.c +1 -1
@@ -224,7 +224,7 @@ void rt2x00lib_txdone(struct queue_entry
 	/*
 	 * If the IV/EIV data was stripped from the frame before it was
 	 * passed to the hardware, we should now reinsert it again because
-	 * mac80211 will expect the the same data to be present it the
+	 * mac80211 will expect the same data to be present it the
 	 * frame as it was passed to us.
 	 */
 	if (test_bit(CONFIG_SUPPORT_HW_CRYPTO, &rt2x00dev->flags))
drivers/net/wireless/zd1211rw/zd_mac.c +1 -1
@@ -855,7 +855,7 @@ int zd_mac_rx(struct ieee80211_hw *hw, c
 	if (skb == NULL)
 		return -ENOMEM;
 	if (need_padding) {
-		/* Make sure the the payload data is 4 byte aligned. */
+		/* Make sure the payload data is 4 byte aligned. */
 		skb_reserve(skb, 2);
 	}
 
drivers/net/wireless/zd1211rw/zd_usb.c +1 -1
@@ -844,7 +844,7 @@ out:
  * @usb: a &struct zd_usb pointer
  * @urb: URB to be freed
  *
- * Frees the the transmission URB, which means to put it on the free URB
+ * Frees the transmission URB, which means to put it on the free URB
  * list.
  */
 static void free_tx_urb(struct zd_usb *usb, struct urb *urb)
include/linux/nl80211.h +1 -1
@@ -132,7 +132,7 @@
  * 	%NL80211_ATTR_REG_RULE_POWER_MAX_ANT_GAIN and
  * 	%NL80211_ATTR_REG_RULE_POWER_MAX_EIRP.
  * @NL80211_CMD_REQ_SET_REG: ask the wireless core to set the regulatory domain
- * 	to the the specified ISO/IEC 3166-1 alpha2 country code. The core will
+ * 	to the specified ISO/IEC 3166-1 alpha2 country code. The core will
  * 	store this as a valid request and then query userspace for it.
  *
  * @NL80211_CMD_GET_MESH_PARAMS: Get mesh networking properties for the
include/net/cfg80211.h +1 -1
@@ -90,7 +90,7 @@ enum ieee80211_channel_flags {
  * @max_power: maximum transmission power (in dBm)
  * @beacon_found: helper to regulatory code to indicate when a beacon
  *	has been found on this channel. Use regulatory_hint_found_beacon()
- *	to enable this, this is is useful only on 5 GHz band.
+ *	to enable this, this is useful only on 5 GHz band.
  * @orig_mag: internal use
  * @orig_mpwr: internal use
  */
net/mac80211/mlme.c +1 -1
@@ -1767,7 +1767,7 @@ static void ieee80211_sta_work(struct wo
 
 	/*
 	 * ieee80211_queue_work() should have picked up most cases,
-	 * here we'll pick the the rest.
+	 * here we'll pick the rest.
 	 */
 	if (WARN(local->suspended, "STA MLME work scheduled while "
 		 "going to suspend\n"))
net/mac80211/status.c +1 -1
@@ -47,7 +47,7 @@ static void ieee80211_handle_filtered_fr
 	/*
 	 * This skb 'survived' a round-trip through the driver, and
 	 * hopefully the driver didn't mangle it too badly. However,
-	 * we can definitely not rely on the the control information
+	 * we can definitely not rely on the control information
 	 * being correct. Clear it so we don't get junk there, and
 	 * indicate that it needs new processing, but must not be
 	 * modified/encrypted again.
net/mac80211/work.c +1 -1
@@ -840,7 +840,7 @@ static void ieee80211_work_work(struct w
 
 	/*
 	 * ieee80211_queue_work() should have picked up most cases,
-	 * here we'll pick the the rest.
+	 * here we'll pick the rest.
 	 */
 	if (WARN(local->suspended, "work scheduled while going to suspend\n"))
 		return;