Tweak comments, reorder target_os in #[cfg] conditions.

Author: mwanner

src/ifaddrs.rs

@@ -108,9 +108,10 @@ impl Iterator for InterfaceAddressIterator {
 
 /// Get interface addresses using libc's `getifaddrs`
 ///
-/// Note that the underlying implementation differs between OSes and the nix
-/// crate doesn't support `AF_PACKET` entries. Therefore, the returned list
-/// often contains empty entries.
+/// Note that the underlying implementation differs between OSes. Only the
+/// most common address families are supported by the nix crate (due to
+/// lack of time and complexity of testing). For any entry not supported,
+/// the returned list will contain a `None` entry.
 ///
 /// # Example
 /// ```

src/lib.rs

@@ -43,8 +43,13 @@ pub mod poll;
 
 pub mod net;
 
-#[cfg(any(target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd",
-          target_os = "ios", target_os = "macos", target_os = "openbsd", target_os = "linux", ))]
+#[cfg(any(target_os = "dragonfly",
+          target_os = "freebsd",
+          target_os = "ios",
+          target_os = "linux",
+          target_os = "macos",
+          target_os = "netbsd",
+          target_os = "openbsd"))]
 pub mod ifaddrs;
 
 #[cfg(any(target_os = "linux", target_os = "android"))]

src/net/if_.rs

@@ -36,17 +36,26 @@ libc_bitflags!(
         /// Interface is a point-to-point link. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
         IFF_POINTOPOINT;
-        #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "ios",
-                  target_os = "linux", target_os = "macos", target_os = "netbsd",
-                  target_os = "openbsd"))]
         /// Avoid use of trailers. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
+        #[cfg(any(target_os = "android",
+                  target_os = "fuchsia",
+                  target_os = "ios",
+                  target_os = "linux",
+                  target_os = "macos",
+                  target_os = "netbsd",
+                  target_os = "openbsd"))]
         IFF_NOTRAILERS;
-        #[cfg(any(target_os = "android", target_os = "dragonfly", target_os = "fuchsia",
-                  target_os = "ios", target_os = "linux", target_os = "macos",
-                  target_os = "netbsd", target_os = "openbsd"))]
         /// Resources allocated. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
+        #[cfg(any(target_os = "android",
+                  target_os = "dragonfly",
+                  target_os = "fuchsia",
+                  target_os = "ios",
+                  target_os = "linux",
+                  target_os = "macos",
+                  target_os = "netbsd",
+                  target_os = "openbsd"))]
         IFF_RUNNING;
         /// No arp protocol, L2 destination address not set. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
@@ -57,28 +66,28 @@ libc_bitflags!(
         /// Receive all multicast packets. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
         IFF_ALLMULTI;
-        #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))]
         /// Master of a load balancing bundle. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
-        IFF_MASTER;
         #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))]
+        IFF_MASTER;
         /// Slave of a load balancing bundle. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
+        #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))]
         IFF_SLAVE;
         /// Supports multicast. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
         IFF_MULTICAST;
-        #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))]
         /// Is able to select media type via ifmap. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
-        IFF_PORTSEL;
         #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))]
+        IFF_PORTSEL;
         /// Auto media selection active. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
-        IFF_AUTOMEDIA;
         #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))]
+        IFF_AUTOMEDIA;
         /// The addresses are lost when the interface goes down. (see
         /// [`netdevice(7)`](http://man7.org/linux/man-pages/man7/netdevice.7.html))
+        #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))]
         IFF_DYNAMIC;
     }
 );