From: Bob Halley <halley@dnspython.org>
Date: Sun, 10 May 2020 16:36:45 +0000 (-0700)
Subject: add info about compression assumptions in dns.name.Name.to_wire()
X-Git-Tag: v2.0.0rc1~233
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e26d80d9d21aef41c2835c260efbd4b6bb642467;p=thirdparty%2Fdnspython.git

add info about compression assumptions in dns.name.Name.to_wire()
---

diff --git a/dns/name.py b/dns/name.py
index addfa9a8..1d151c6d 100644
--- a/dns/name.py
+++ b/dns/name.py
@@ -613,7 +613,10 @@ class Name(object):
         containing the wire name will be returned.
 
         *compress*, a ``dict``, is the compression table to use.  If
-        ``None`` (the default), names will not be compressed.
+        ``None`` (the default), names will not be compressed.  Note that
+        the compression code assumes that compression offset 0 is the
+        start of *file*, and thus compression will not be correct
+        if this is not the case.
 
         *origin* is a ``dns.name.Name`` or ``None``.  If the name is
         relative and origin is not ``None``, then *origin* will be appended