From 6d67bd6eaf3fd53abdefa596a11e00d2d47bdbee Mon Sep 17 00:00:00 2001 From: Remi Gacogne Date: Tue, 29 Apr 2025 10:57:02 +0200 Subject: [PATCH] dnsdist: Document the return value of `DNSCryptContext::generateAndLoadInMemoryCertificate` --- pdns/dnsdistdist/docs/reference/dnscrypt.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) 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 -- 2.47.2