From: Remi Gacogne Date: Tue, 29 Apr 2025 08:57:02 +0000 (+0200) Subject: dnsdist: Document the return value of `DNSCryptContext::generateAndLoadInMemoryCertif... X-Git-Tag: dnsdist-2.0.0-alpha2~41^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F15463%2Fhead;p=thirdparty%2Fpdns.git dnsdist: Document the return value of `DNSCryptContext::generateAndLoadInMemoryCertificate` --- diff --git a/pdns/dnsdistdist/docs/reference/dnscrypt.rst b/pdns/dnsdistdist/docs/reference/dnscrypt.rst index 46f2f89e8d..630da631db 100644 --- a/pdns/dnsdistdist/docs/reference/dnscrypt.rst +++ b/pdns/dnsdistdist/docs/reference/dnscrypt.rst @@ -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