Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

etherdevice: fix comments

Fix some minor problems in comments of etherdevice.h
* Warning is out dated, file hasn't moved or disappeared in many years and
is unlikely to do so soon.
* Capitalize Ethernet consistently since it is a proper name
* Fix descriptive comment of padding
* Spelling and grammar fix for alignment comment

Signed-off-by: Stephen Hemminger <shemminger@vyatta.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

stephen hemminger and committed by
David S. Miller
048b899c 3b12bb60

+6 -8
+6 -8
include/linux/etherdevice.h
··· 18 18 * as published by the Free Software Foundation; either version 19 19 * 2 of the License, or (at your option) any later version. 20 20 * 21 - * WARNING: This move may well be temporary. This file will get merged with others RSN. 22 - * 23 21 */ 24 22 #ifndef _LINUX_ETHERDEVICE_H 25 23 #define _LINUX_ETHERDEVICE_H ··· 157 159 * @addr1: Pointer to a six-byte array containing the Ethernet address 158 160 * @addr2: Pointer other six-byte array containing the Ethernet address 159 161 * 160 - * Compare two ethernet addresses, returns 0 if equal, non-zero otherwise. 162 + * Compare two Ethernet addresses, returns 0 if equal, non-zero otherwise. 161 163 * Unlike memcmp(), it doesn't return a value suitable for sorting. 162 164 */ 163 165 static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2) ··· 174 176 * @addr1: Pointer to a six-byte array containing the Ethernet address 175 177 * @addr2: Pointer other six-byte array containing the Ethernet address 176 178 * 177 - * Compare two ethernet addresses, returns true if equal 179 + * Compare two Ethernet addresses, returns true if equal 178 180 */ 179 181 static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2) 180 182 { ··· 195 197 * @addr1: Pointer to an array of 8 bytes 196 198 * @addr2: Pointer to an other array of 8 bytes 197 199 * 198 - * Compare two ethernet addresses, returns true if equal, false otherwise. 200 + * Compare two Ethernet addresses, returns true if equal, false otherwise. 199 201 * 200 202 * The function doesn't need any conditional branches and possibly uses 201 203 * word memory accesses on CPU allowing cheap unaligned memory reads. 202 - * arrays = { byte1, byte2, byte3, byte4, byte6, byte7, pad1, pad2} 204 + * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 } 203 205 * 204 - * Please note that alignment of addr1 & addr2 is only guaranted to be 16 bits. 206 + * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits. 205 207 */ 206 208 207 209 static inline bool ether_addr_equal_64bits(const u8 addr1[6+2], ··· 255 257 * @a: Pointer to Ethernet header 256 258 * @b: Pointer to Ethernet header 257 259 * 258 - * Compare two ethernet headers, returns 0 if equal. 260 + * Compare two Ethernet headers, returns 0 if equal. 259 261 * This assumes that the network header (i.e., IP header) is 4-byte 260 262 * aligned OR the platform can handle unaligned access. This is the 261 263 * case for all packets coming into netif_receive_skb or similar