From: Pieter Lexis Date: Wed, 21 Mar 2018 16:17:29 +0000 (+0100) Subject: Small documentation fixes X-Git-Tag: dnsdist-1.3.0~37^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F6045%2Fhead;p=thirdparty%2Fpdns.git Small documentation fixes --- diff --git a/pdns/dnsdistdist/docs/reference/dnscrypt.rst b/pdns/dnsdistdist/docs/reference/dnscrypt.rst index 9e67e999a2..c597dbecbf 100644 --- a/pdns/dnsdistdist/docs/reference/dnscrypt.rst +++ b/pdns/dnsdistdist/docs/reference/dnscrypt.rst @@ -26,7 +26,8 @@ DNSCrypt objects and functions :param string publicKey: path to write the public key to :param string privateKey: path to write the private key to -.. function:: generateDNSCryptCertificate(privatekey, certificate, keyfile, serial, validFrom, validUntil, version) +.. function:: generateDNSCryptCertificate(privatekey, certificate, keyfile, serial, validFrom, validUntil[, version]) + .. versionchanged:: 1.3.0 ``version`` optional parameter added. @@ -144,6 +145,27 @@ Context :param int end: Unix timestamp from until the certificate is valid :param DNSCryptExchangeVersion version: The exchange version to use. Possible values are ``DNSCryptExchangeVersion::VERSION1`` (default, X25519-XSalsa20Poly1305) and ``DNSCryptExchangeVersion::VERSION2`` (X25519-XChacha20Poly1305) + .. method:: DNSCryptContext:getCurrentCertificate() -> DNSCryptCert + + .. deprecated:: 1.3.0 + Removed as it relied on one certificate. See :meth:`DNSCryptContext:getCertificate`. + + Return the current certificate. + + .. method:: DNSCryptContext:getOldCertificate() -> DNSCryptCert + + .. deprecated:: 1.3.0 + Removed as it relied on one certificate. + + Return the previous certificate. + + .. method:: DNSCryptContext:hasOldCertificate() -> bool + + .. deprecated:: 1.3.0 + Removed as it relied on one certificate. + + Whether or not the context has a previous certificate, from a certificate rotation. + .. method:: DNSCryptContext:getCertificate(index) -> DNSCryptCert .. versionadded:: 1.3.0