From 85b75ab1166b9d624aba2f392982e8035317b80b Mon Sep 17 00:00:00 2001 From: Remi Gacogne Date: Mon, 23 May 2022 13:30:06 +0200 Subject: [PATCH] dnsdist: Document the return value of getMACAddress() As suggested by Otto. --- pdns/dnsdistdist/docs/reference/config.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pdns/dnsdistdist/docs/reference/config.rst b/pdns/dnsdistdist/docs/reference/config.rst index 32d8d4aef9..c652674c16 100644 --- a/pdns/dnsdistdist/docs/reference/config.rst +++ b/pdns/dnsdistdist/docs/reference/config.rst @@ -986,11 +986,12 @@ Status, Statistics and More Return the list of network interfaces configured on the system, as strings. This function requires support for ``getifaddrs``, which is known to be present on FreeBSD, Linux, and OpenBSD at least. -.. function:: getMACAddress(ip) +.. function:: getMACAddress(ip) -> str .. versionadded:: 1.8.0 Return the link-level address (MAC) corresponding to the supplied neighbour IP address, if known by the kernel. + The link-level address is returned as a raw binary string. An empty string is returned if no matching entry has been found. This function is only implemented on Linux. :param str ip: The IP address, IPv4 or IPv6, to look up the corresponding link-level address for. -- 2.47.3