@@ -33,15 +33,21 @@ impl WireguardInterfaceApi for WGApi<Kernel> {
3333 /// Add peer addresses to network routing table.
3434 ///
3535 /// For every allowed IP, it runs:
36- /// - `route -q -n add <inet> allowed_ip -interface if_name`
37- /// `ifname` - interface name while creating api
38- /// `allowed_ip`- one of [Peer](crate::Peer) allowed ip
36+ /// `route -q -n add <inet> allowed_ip -interface if_name`
37+ ///
38+ /// Where:
39+ /// - `ifname` - interface name while creating api
40+ /// - `allowed_ip`- one of [Peer](crate::Peer) allowed ip
41+ ///
3942 /// For `0.0.0.0/0` or `::/0` allowed IP, it adds default routing and skips other using:
40- /// - `route -q -n add <inet> 0.0.0.0/1 -interface if_name`.
41- /// - `route -q -n add <inet> 128.0.0.0/1 -interface if_name`.
42- /// - `route -q -n add <inet> <endpoint> -gateway <gateway>`
43- /// `<endpoint>` - Add routing for every unique Peer endpoint.
44- /// `<gateway>`- Gateway extracted using `netstat -nr -f <inet>`.
43+ /// - `route -q -n add <inet> 0.0.0.0/1 -interface if_name`.
44+ /// - `route -q -n add <inet> 128.0.0.0/1 -interface if_name`.
45+ /// - `route -q -n add <inet> <endpoint> -gateway <gateway>`
46+ ///
47+ /// Where:
48+ /// - `<endpoint>` - Add routing for every unique Peer endpoint.
49+ /// - `<gateway>`- Gateway extracted using `netstat -nr -f <inet>`.
50+ ///
4551 /// ## Note:
4652 /// Based on ip type `<inet>` will be equal to `-inet` or `-inet6`
4753 fn configure_peer_routing ( & self , peers : & [ Peer ] ) -> Result < ( ) , WireguardInterfaceError > {
0 commit comments