summaryrefslogtreecommitdiffstats
path: root/modules/hints/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'modules/hints/README.rst')
-rw-r--r--modules/hints/README.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/modules/hints/README.rst b/modules/hints/README.rst
index 97d24ddc..7d775188 100644
--- a/modules/hints/README.rst
+++ b/modules/hints/README.rst
@@ -8,8 +8,7 @@ Static hints
This is a module providing static hints for forward records (A/AAAA) and reverse records (PTR).
The records can be loaded from ``/etc/hosts``-like files and/or added directly.
-You can also use the module to change the root hints; they are used as a safety belt or if the root NS
-drops out of cache.
+You can also use the module to change fallback addresses for the root servers.
.. tip::
@@ -110,6 +109,9 @@ Properties
Replace current root hints and return the current table of root hints.
+ These root hints are only used as fallback when addresses of ``NS .`` aren't available,
+ e.g. when cache is completely clear.
+
.. tip:: If no parameters are passed, it only returns current root hints set without changing anything.
Example:
@@ -127,8 +129,6 @@ Properties
[1] => 202.12.27.33
}
- .. tip:: A good rule of thumb is to select only a few fastest root hints. The server learns RTT and NS quality over time, and thus tries all servers available. You can help it by preselecting the candidates.
-
.. function:: hints.use_nodata(toggle)
:param bool toggle: true if enabling NODATA synthesis, false if disabling
@@ -136,6 +136,8 @@ Properties
If set to true (the default), NODATA will be synthesised for matching hint name, but mismatching type (e.g. AAAA query when only A hint exists).
+ The setting is (now) per-entry, so you want to set it before any address-name pairs.
+
.. function:: hints.ttl([new_ttl])
:param int new_ttl: new TTL to set (optional)
@@ -143,3 +145,5 @@ Properties
This function allows to read and write the TTL value used for records generated by the hints module.
+ The setting is (now) per-entry, so you want to set it before any address-name pairs.
+