diff mbox series

[v3,5/9] various: Comment spell-fixes, new comments for extra clarification

Message ID 20240409030540.77576-6-newtwen+github@gmail.com
State New
Headers show
Series odhcpd patchset | expand

Commit Message

Paul Donald April 9, 2024, 3:04 a.m. UTC
From: Paul Donald <newtwen@gmail.com>

Signed-off-by: Paul Donald <newtwen@gmail.com>
Reviewed-by: Daniel Golle <daniel@makrotopia.org>
---
 src/config.c    | 1 +
 src/dhcpv4.c    | 2 +-
 src/dhcpv6-ia.c | 6 +++---
 src/ndp.c       | 4 ++--
 src/netlink.c   | 2 +-
 src/router.c    | 6 +++---
 6 files changed, 11 insertions(+), 10 deletions(-)
diff mbox series

Patch

diff --git a/src/config.c b/src/config.c
index 1cd4608..0368e74 100644
--- a/src/config.c
+++ b/src/config.c
@@ -892,6 +892,7 @@  int config_parse_interface(void *data, size_t len, const char *name, bool overwr
 	if ((c = tb[IFACE_ATTR_RA_DEFAULT]))
 		iface->default_router = blobmsg_get_u32(c);
 
+	/* IFACE_ATTR_RA_MANAGEMENT aka ra_management is deprecated since 2019 */
 	if (!tb[IFACE_ATTR_RA_FLAGS] && !tb[IFACE_ATTR_RA_SLAAC] &&
 	    (c = tb[IFACE_ATTR_RA_MANAGEMENT])) {
 		switch (blobmsg_get_u32(c)) {
diff --git a/src/dhcpv4.c b/src/dhcpv4.c
index 3191ff2..cb0484f 100644
--- a/src/dhcpv4.c
+++ b/src/dhcpv4.c
@@ -893,7 +893,7 @@  void dhcpv4_handle_msg(void *addr, void *data, size_t len,
 		struct arpreq arp = {.arp_flags = ATF_COM};
 
 		/*
-		 * send reply to the newly (in this proccess) allocated IP
+		 * send reply to the newly (in this process) allocated IP
 		 */
 		dest.sin_addr = reply.yiaddr;
 		dest.sin_port = htons(DHCPV4_CLIENT_PORT);
diff --git a/src/dhcpv6-ia.c b/src/dhcpv6-ia.c
index 39a316a..dde224d 100644
--- a/src/dhcpv6-ia.c
+++ b/src/dhcpv6-ia.c
@@ -1142,11 +1142,11 @@  static size_t build_ia(uint8_t *buf, size_t buflen, uint16_t status,
 		}
 
 		if (!INFINITE_VALID(a->valid_until))
-			/* UINT32_MAX is considered as infinite leasetime */
+			/* UINT32_MAX is RFC defined as infinite lease-time */
 			a->valid_until = (valid_lt == UINT32_MAX) ? 0 : valid_lt + now;
 
 		if (!INFINITE_VALID(a->preferred_until))
-			/* UINT32_MAX is considered as infinite leasetime */
+			/* UINT32_MAX is RFC defined as infinite lease-time */
 			a->preferred_until = (preferred_lt == UINT32_MAX) ? 0 : preferred_lt + now;
 
 		o_ia.t1 = htonl((preferred_lt == UINT32_MAX) ? preferred_lt : preferred_lt * 5 / 10);
@@ -1570,7 +1570,7 @@  ssize_t dhcpv6_ia_handle_IAs(uint8_t *buf, size_t buflen, struct interface *ifac
 				/* Set error status */
 				status = (is_pd) ? DHCPV6_STATUS_NOPREFIXAVAIL : DHCPV6_STATUS_NOADDRSAVAIL;
 			else if (hdr->msg_type == DHCPV6_MSG_REQUEST && !dhcpv6_ia_on_link(ia, a, iface)) {
-				/* Send NOTONLINK staus for the IA */
+				/* Send NOTONLINK status for the IA */
 				status = DHCPV6_STATUS_NOTONLINK;
 				assigned = false;
 			} else if (accept_reconf && assigned && !first &&
diff --git a/src/ndp.c b/src/ndp.c
index dfbb111..0ec6fed 100644
--- a/src/ndp.c
+++ b/src/ndp.c
@@ -39,7 +39,7 @@  static void setup_addr_for_relaying(struct in6_addr *addr, struct interface *ifa
 static void handle_solicit(void *addr, void *data, size_t len,
 		struct interface *iface, void *dest);
 
-/* Filter ICMPv6 messages of type neighbor soliciation */
+/* Filter ICMPv6 messages of type neighbor solicitation */
 static struct sock_filter bpf[] = {
 	BPF_STMT(BPF_LD | BPF_B | BPF_ABS, offsetof(struct ip6_hdr, ip6_nxt)),
 	BPF_JUMP(BPF_JMP | BPF_JEQ | BPF_K, IPPROTO_ICMPV6, 0, 3),
@@ -343,7 +343,7 @@  static void handle_solicit(void *addr, void *data, size_t len,
 		return;
 
 	if (len < sizeof(*ip6) + sizeof(*req))
-		return; // Invalid reqicitation
+		return; // Invalid total length
 
 	if (IN6_IS_ADDR_LINKLOCAL(&req->nd_ns_target) ||
 			IN6_IS_ADDR_LOOPBACK(&req->nd_ns_target) ||
diff --git a/src/netlink.c b/src/netlink.c
index c33e3ea..368e69c 100644
--- a/src/netlink.c
+++ b/src/netlink.c
@@ -213,7 +213,7 @@  static void refresh_iface_addr6(int ifindex)
 
 			if (change) {
 				/*
-				 * Keep track on removed prefixes, so we could advertise them as invalid
+				 * Keep track of removed prefixes, so we could advertise them as invalid
 				 * for at least a couple of times.
 				 *
 				 * RFC7084 § 4.3 :
diff --git a/src/router.c b/src/router.c
index c35180d..05522dc 100644
--- a/src/router.c
+++ b/src/router.c
@@ -666,7 +666,7 @@  static int send_router_advert(struct interface *iface, const struct in6_addr *fr
 		uint8_t *search_domain = iface->search;
 		uint8_t search_buf[256];
 
-		/* DNS Recursive DNS */
+		/* DNS Recursive DNS aka RDNSS Type 25; RFC8106 */
 		if (iface->dns_cnt > 0) {
 			dns_addr = iface->dns;
 			dns_cnt = iface->dns_cnt;
@@ -686,7 +686,7 @@  static int send_router_advert(struct interface *iface, const struct in6_addr *fr
 			memcpy(dns->addr, dns_addr, sizeof(struct in6_addr)*dns_cnt);
 		}
 
-		/* DNS Search options */
+		/* DNS Search options aka DNSSL Type 31; RFC8106 */
 		if (!search_domain && !res_init() && _res.dnsrch[0] && _res.dnsrch[0][0]) {
 			int len = dn_comp(_res.dnsrch[0], search_buf,
 					sizeof(search_buf), NULL, NULL);
@@ -717,7 +717,7 @@  static int send_router_advert(struct interface *iface, const struct in6_addr *fr
 	iov[IOV_RA_SEARCH].iov_len = search_sz;
 
 	if (iface->pref64_length) {
-		/* RFC 8781 § 4.1 rounding up lifetime to multiply of 8 */
+		/* RFC 8781 § 4.1 rounding up lifetime to multiple of 8 */
 		uint16_t pref64_lifetime = lifetime < (UINT16_MAX - 7) ? lifetime + 7 : UINT16_MAX;
 		uint8_t prefix_length_code;
 		uint32_t mask_a1, mask_a2;