diff mbox series

[v4,7/8] wpa_supplicant: doc: Replace Native Part 1.

Message ID 20210716053211.2716392-7-arowa@google.com
State Superseded
Headers show
Series [v4,1/8] wpa_supplicant: hostapd: Replace MITM with PITM. | expand

Commit Message

Arowa Suliman July 16, 2021, 5:32 a.m. UTC
Replaced the word Native with more inclusive words such as built-in.

Signed-off-by: Arowa Suliman <arowa@chromium.org>
---
 doc/code_structure.doxygen | 2 +-
 doc/driver_wrapper.doxygen | 2 +-
 doc/p2p.doxygen            | 4 ++--
 doc/porting.doxygen        | 2 +-
 wpa_supplicant/ChangeLog   | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

Comments

Jouni Malinen Aug. 19, 2021, 9:03 a.m. UTC | #1
On Thu, Jul 15, 2021 at 10:32:10PM -0700, Arowa Suliman wrote:
> Replaced the word Native with more inclusive words such as built-in.

> diff --git a/doc/code_structure.doxygen b/doc/code_structure.doxygen
> @@ -62,7 +62,7 @@ with with hostapd. The following C files are currently used:
>  	Definitions shared by multiple files
>  
>  \ref l2_packet.h, \ref l2_packet_linux.c, and \ref l2_packet_pcap.c
> -	Layer 2 (link) access wrapper (includes native Linux implementation
> +	Layer 2 (link) access wrapper (includes built-in Linux implementation
>  	and wrappers for libdnet/libpcap). A new l2_packet implementation

This feels incorrect since the reference here is to something being a
native function in an operating system instead of a wrapper or an
adaptation layer on top of that. Both of those could be built-in into
the operating system and this comparison here is between things that
need to use an adaption layer to access an interface and things that do
not need such an extra layer. It would probably be better to replace
this comparison with more specific names of the interfaces instead of
this type of a comparison if there is desire to get rid of this type of
use of the word "native". In other words, something like "includes Linux
packet socket and wrappers for libdnet/libpcap".

> diff --git a/doc/driver_wrapper.doxygen b/doc/driver_wrapper.doxygen
> +++ b/doc/driver_wrapper.doxygen
>  When porting to other operating systems, the driver wrapper should be
> -modified to use the native interface of the target OS. It is possible
> +modified to use the built-in interface of the target OS. It is possible

A similar comment would apply here.

> diff --git a/doc/porting.doxygen b/doc/porting.doxygen
> @@ -21,7 +21,7 @@ most targets. However, couple of additional functions that are common
>  on modern UNIX systems are used. Number of these are listed with
>  prototypes in \ref common.h (the \verbatim #ifdef CONFIG_ANSI_C_EXTRA \endverbatim
>  block). These functions may need to be implemented or at least defined
> -as macros to native functions in the target OS or C library.
> +as macros to built-in functions in the target OS or C library.

And here.

> diff --git a/wpa_supplicant/ChangeLog b/wpa_supplicant/ChangeLog
> @@ -1864,7 +1864,7 @@ ChangeLog for wpa_supplicant
>  	  generate, e.g., man pages
>  	* l2_packet_linux: use socket type SOCK_DGRAM instead of SOCK_RAW for
>  	  PF_PACKET in order to prepare for network devices that do not use
> -	  Ethernet headers (e.g., network stack with native IEEE 802.11 frames)
> +	  Ethernet headers (e.g., network stack with original IEEE 802.11 frames)

"original" here seems a bit confusing since there is a special meaning
for "native IEEE 802.11/wifi/etc." in various implementations to
reference a case where the frame header has not been converted into the
Ethernet format. Such cases can either provide the exact header used in
the over-the-air frame or a modified variant of the 802.11 header.
"original" would be fine for the former, but it would be incorrect for
the latter. "network stack that includes IEEE 802.11 headers" could be a
more accurate replacement for this.
diff mbox series

Patch

diff --git a/doc/code_structure.doxygen b/doc/code_structure.doxygen
index 3a3b21b72..c7ed5c71a 100644
--- a/doc/code_structure.doxygen
+++ b/doc/code_structure.doxygen
@@ -62,7 +62,7 @@  with with hostapd. The following C files are currently used:
 	Definitions shared by multiple files
 
 \ref l2_packet.h, \ref l2_packet_linux.c, and \ref l2_packet_pcap.c
-	Layer 2 (link) access wrapper (includes native Linux implementation
+	Layer 2 (link) access wrapper (includes built-in Linux implementation
 	and wrappers for libdnet/libpcap). A new l2_packet implementation
 	may need to be added when porting to new operating systems that are
 	not supported by libdnet/libpcap. Makefile can be used to select which
diff --git a/doc/driver_wrapper.doxygen b/doc/driver_wrapper.doxygen
index 66211b3ab..fde256564 100644
--- a/doc/driver_wrapper.doxygen
+++ b/doc/driver_wrapper.doxygen
@@ -27,7 +27,7 @@  documented in \ref driver.h. In addition, a pointer to the 'struct
 \ref wpa_driver_ops' needs to be registered in \ref drivers.c file.
 
 When porting to other operating systems, the driver wrapper should be
-modified to use the native interface of the target OS. It is possible
+modified to use the built-in interface of the target OS. It is possible
 that some extra requirements for the interface between the driver
 wrapper and generic wpa_supplicant code are discovered during porting
 to a new operating system. These will be addressed on case by case
diff --git a/doc/p2p.doxygen b/doc/p2p.doxygen
index d4d86e3ed..475295e94 100644
--- a/doc/p2p.doxygen
+++ b/doc/p2p.doxygen
@@ -274,8 +274,8 @@  for removing the group interface for the failed group.
 P2P protocol includes service discovery functionality that can be used
 to discover which services are provided by the peers before forming a
 group. This leverages the Generic Advertisement Service (GAS) protocol
-from IEEE 802.11u and P2P vendor-specific contents inside the Native
-GAS messages.
+from IEEE 802.11u and P2P vendor-specific contents inside the GAS 
+messages.
 
 The P2P module takes care of GAS encapsulation, fragmentation, and
 actual transmission and reception of the Action frames needed for
diff --git a/doc/porting.doxygen b/doc/porting.doxygen
index b4b78ef05..2144a4053 100644
--- a/doc/porting.doxygen
+++ b/doc/porting.doxygen
@@ -21,7 +21,7 @@  most targets. However, couple of additional functions that are common
 on modern UNIX systems are used. Number of these are listed with
 prototypes in \ref common.h (the \verbatim #ifdef CONFIG_ANSI_C_EXTRA \endverbatim
 block). These functions may need to be implemented or at least defined
-as macros to native functions in the target OS or C library.
+as macros to built-in functions in the target OS or C library.
 
 Many of the common ANSI C functions are used through a wrapper
 definitions in \ref os.h to allow these to be replaced easily with a
diff --git a/wpa_supplicant/ChangeLog b/wpa_supplicant/ChangeLog
index a06a93b22..34318f489 100644
--- a/wpa_supplicant/ChangeLog
+++ b/wpa_supplicant/ChangeLog
@@ -1864,7 +1864,7 @@  ChangeLog for wpa_supplicant
 	  generate, e.g., man pages
 	* l2_packet_linux: use socket type SOCK_DGRAM instead of SOCK_RAW for
 	  PF_PACKET in order to prepare for network devices that do not use
-	  Ethernet headers (e.g., network stack with native IEEE 802.11 frames)
+	  Ethernet headers (e.g., network stack with original IEEE 802.11 frames)
 	* use receipt of EAPOL-Key frame as a lower layer success indication
 	  for EAP state machine to allow recovery from dropped EAP-Success
 	  frame