Skip to content

Commit 2a32b04

Browse files
committed
Added some documentation for the edns-cookies extension
1 parent 613c20d commit 2a32b04

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

doc/functions.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ Extensions are Python dictionaries, with the keys being the names of the
253253
extensions. The definition of each extension describes the values that
254254
may be assigned to that extension. For most extensions it is a Boolean,
255255
and since the default value is "False" it will most often take the value
256-
``getdns.GETDNS_EXTENSION_TRUE``.
256+
``getdns.EXTENSION_TRUE``.
257257

258258
The extensions currently supported by :py:mod:`getdns` are:
259259

@@ -266,6 +266,12 @@ The extensions currently supported by :py:mod:`getdns` are:
266266
* ``specify_class``
267267
* ``return_call_debugging``
268268

269+
Extensions that are optionally built (see above) include
270+
271+
* ``edns-cookies``
272+
273+
``edns-cookies`` also takes the value ``getdns.EXTENSION_TRUE``.
274+
269275
Extensions for DNSSEC
270276
^^^^^^^^^^^^^^^^^^^^^
271277

doc/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ as follows:
4545

4646
./configure --with-libevent
4747

48+
To enable the use of edns cookies in the Python bindings,
49+
you must compile support for them into libgetdns, by
50+
including the --enable-draft-edns-cookies argument to
51+
configure.
52+
4853
This release has been tested against libgetdns 0.1.7.
4954

5055
Building
@@ -67,6 +72,12 @@ build and install:
6772
python setup.py build
6873
python setup.py install
6974

75+
We've added optional support for draft-ietf-dnsop-cookies.
76+
It is implemented as a getdns extension (see below). It is
77+
not built by default. To enable it, you must build
78+
libgetdns with cookies support and add the
79+
``--with-edns-cookies`` to the Python module build
80+
(i.e. ``python setup.py build --with-edns-cookies``).
7081

7182
Using getdns
7283
==============

0 commit comments

Comments
 (0)