socket: add missing docs for ethernet sockets

Author: ususdei

README.md

@@ -205,7 +205,7 @@ Enable `smoltcp::phy::RawSocket` and `smoltcp::phy::TunTapInterface`, respective
 
 These features are enabled by default.
 
-### Features `socket-raw`, `socket-udp`, `socket-tcp`, `socket-icmp`, `socket-dhcpv4`, `socket-dns`
+### Features `socket-eth`, `socket-raw`, `socket-udp`, `socket-tcp`, `socket-icmp`, `socket-dhcpv4`, `socket-dns`
 
 Enable the corresponding socket type.
 

src/socket/eth.rs

@@ -80,10 +80,10 @@ impl core::fmt::Display for EthMetadata {
     }
 }
 
-/// A Eth packet metadata.
+/// An Ethernet packet metadata.
 pub type PacketMetadata = crate::storage::PacketMetadata<EthMetadata>;
 
-/// A Eth packet ring buffer.
+/// An Ethernet packet ring buffer.
 pub type PacketBuffer<'a> = crate::storage::PacketBuffer<'a, EthMetadata>;
 
 pub type Ethertype = u16;

src/socket/raw.rs

@@ -82,6 +82,9 @@ pub type PacketBuffer<'a> = crate::storage::PacketBuffer<'a, ()>;
 ///
 /// A raw socket may be bound to a specific IP protocol, and owns
 /// transmit and receive packet buffers.
+///
+/// A raw socket can only handle IP-based traffic, for raw ethernet
+/// traffic look at `eth::Socket`.
 #[derive(Debug)]
 pub struct Socket<'a> {
     ip_version: Option<IpVersion>,