From: Karel Bilek <kb@karelbilek.com>
Date: Tue, 4 Mar 2025 07:52:44 +0000 (+0100)
Subject: dnsdist docs: copy newCAFromRaw from pdns
X-Git-Tag: dnsdist-2.0.0-alpha1~40^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=342da9ad838939f6177f575b2f00971d20d4cf8d;p=thirdparty%2Fpdns.git

dnsdist docs: copy newCAFromRaw from pdns
---

diff --git a/pdns/dnsdistdist/docs/reference/comboaddress.rst b/pdns/dnsdistdist/docs/reference/comboaddress.rst
index 79d05ad99d..704c5f40ed 100644
--- a/pdns/dnsdistdist/docs/reference/comboaddress.rst
+++ b/pdns/dnsdistdist/docs/reference/comboaddress.rst
@@ -12,6 +12,14 @@ ComboAddresses can be IPv4 or IPv6, and unless you want to know, you don't need
 
   :param string address: The IP address, with optional port, to represent.
 
+.. function:: newCAFromRaw(rawaddress[, port]) -> ComboAddress
+
+  Returns a new :class:`ComboAddress` object based on the 4- or 16-octet string.
+  For example, ``newCAFromRaw('ABCD')`` makes a ``ComboAddress`` object holding the IP ``65.66.67.68``, because those are the ASCII values for those four letters.
+
+  :param string rawaddress: The IPv4 of IPv6 address as a 4/16 octet string
+  :param int port: The optional port number
+
 .. class:: ComboAddress
 
   A ``ComboAddress`` represents an IP address with possibly a port number.