Commit 0fd3c6c7 authored by Vladimír Čunát's avatar Vladimír Čunát

hints docs: unify the descriptions of `hints.root()`

(Thanks to Láďa.)
Also try to stress that hints.set() only takes a pair and not more.
parent 2ffa6c10
Pipeline #38249 passed with stages
in 8 minutes and 39 seconds
......@@ -58,11 +58,12 @@ Properties
:param string pair: ``hostname address`` i.e. ``"localhost 127.0.0.1"``
:return: ``{ result: bool }``
Add a hostname - address pair hint.
Add a hostname--address pair hint.
.. note::
If multiple addresses have been added for a name, all are returned in a forward query.
If multiple addresses have been added for a name (in separate ``hints.set()`` commands),
all are returned in a forward query.
If multiple names have been added to an address, the last one defined is returned
in a corresponding PTR query.
......@@ -73,12 +74,6 @@ Properties
Remove a hostname - address pair hint. If address is omitted, all addresses for the given name are deleted.
.. function:: hints.root()
:return: ``{ ['a.root-servers.net.'] = { '1.2.3.4', '5.6.7.8', ...}, ... }``
.. tip:: If no parameters are passed, returns current root hints set.
.. function:: hints.root_file(path)
Replace current root hints from a zonefile. If the path is omitted, the compiled-in path is used, i.e. the root hints are reset to the default.
......@@ -90,6 +85,8 @@ Properties
Replace current root hints and return the current table of root hints.
.. tip:: If no parameters are passed, it only returns current root hints set without changing anything.
Example:
.. code-block:: lua
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment