]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
more doco for CNAME-and-other-data
authorBob Halley <halley@dnspython.org>
Sun, 28 Nov 2021 19:29:11 +0000 (11:29 -0800)
committerBob Halley <halley@dnspython.org>
Thu, 2 Dec 2021 13:14:22 +0000 (05:14 -0800)
dns/node.py

index 261de37a9b01f204bcb6c00884d0a60ef23da5b8..4a750eb01d2d5659ae7154fc4c4d3d73e1ef816b 100644 (file)
@@ -26,7 +26,20 @@ import dns.renderer
 
 class Node:
 
-    """A Node is a set of rdatasets."""
+    """A Node is a set of rdatasets.
+
+    A node is either a CNAME node or an "other data" node.  A CNAME
+    node contains only CNAME, RRSIG(CNAME), NSEC, RRSIG(NSEC), NSEC3,
+    or RRSIG(NSEC3) rdatasets.  An "other data" node contains any
+    rdataset other than a CNAME or RRSIG(CNAME) rdataset.  When
+    changes are made to a node, the CNAME or "other data" state is
+    always consistent with the update, i.e. the most recent change
+    wins.  For example, if you have a node which contains a CNAME
+    rdataset, and then add an MX rdataset to it, then the CNAME
+    rdataset will be deleted.  Likewise if you have a node containing
+    an MX rdataset and add a CNAME rdataset, the MX rdataset will be
+    deleted.
+    """
 
     __slots__ = ['rdatasets']