]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
dnsdist: Document the return value of `DNSCryptContext::generateAndLoadInMemoryCertif... 15463/head
authorRemi Gacogne <remi.gacogne@powerdns.com>
Tue, 29 Apr 2025 08:57:02 +0000 (10:57 +0200)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Tue, 29 Apr 2025 08:58:48 +0000 (10:58 +0200)
pdns/dnsdistdist/docs/reference/dnscrypt.rst

index 46f2f89e8dba0835bb186aee4fd7318f1f9dd186..630da631db64b06c0c96390cedc6fee003308f83 100644 (file)
@@ -146,9 +146,12 @@ Context
     :param DNSCryptPrivateKey key: The private key corresponding to the certificate
     :param bool active: Whether the certificate should be advertised to clients. Default is true
 
-  .. method:: DNSCryptContext:generateAndLoadInMemoryCertificate(keyfile, serial, begin, end [, version])
+  .. method:: DNSCryptContext:generateAndLoadInMemoryCertificate(keyfile, serial, begin, end [, version]) -> bool
 
-    Generate a new resolver key and the associated certificate in-memory, sign it with the provided provider key, and add it to the context
+  .. versionchanged:: 2.0.0
+    A return value indicating whether the certificate was correctly loaded has been added. Before 2.0.0 the method did not return any value.
+
+    Generate a new resolver key and the associated certificate in-memory, sign it with the provided provider key, and add it to the context. Returns true if the certificate was correctly loaded, false otherwise.
 
     :param string keyfile: Path to the provider key file to use
     :param int serial: The serial number of the certificate