From 9d24baaa3d4a6688403b34708a1f4696c7d12c5b Mon Sep 17 00:00:00 2001
From: gdt <gdt>
Date: Tue, 13 Jan 2004 14:55:40 +0000
Subject: Explain the dual use of struct prefix for CIDR prefixes and
 address/netmask pairs, and clarify the two comparison functions.

---
 lib/prefix.h | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'lib/prefix.h')

diff --git a/lib/prefix.h b/lib/prefix.h
index 7d7cde68..5884640a 100644
--- a/lib/prefix.h
+++ b/lib/prefix.h
@@ -23,6 +23,15 @@
 #ifndef _ZEBRA_PREFIX_H
 #define _ZEBRA_PREFIX_H
 
+/*
+ * A struct prefix contains an address family, a prefix length, and an
+ * address.  This can represent either a 'network prefix' as defined
+ * by CIDR, where the 'host bits' of the prefix are 0
+ * (e.g. AF_INET:10.0.0.0/8), or an address and netmask
+ * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
+ * interface.
+ */
+
 /* IPv4 and IPv6 unified prefix structure. */
 struct prefix
 {
-- 
cgit v1.2.1