diff options
| -rw-r--r-- | doc/manual/pkcs11.rst | 17 | ||||
| -rw-r--r-- | doc/manual/tls.rst | 2 | ||||
| -rw-r--r-- | doc/manual/x509.rst | 4 | ||||
| -rwxr-xr-x | src/scripts/build_docs.py | 3 |
4 files changed, 11 insertions, 15 deletions
diff --git a/doc/manual/pkcs11.rst b/doc/manual/pkcs11.rst index e7b5bea26..e8fa4c373 100644 --- a/doc/manual/pkcs11.rst +++ b/doc/manual/pkcs11.rst @@ -238,15 +238,13 @@ A PKCS#11 slot is usually a smart card reader that potentially contains a token. To instantiate this class a reference to a :cpp:class:`Module` object and a ``slot_id`` have to be passed to the constructor. -To retrieve available slot ids this class has the following static method: - .. cpp:function:: static std::vector<SlotId> get_available_slots(Module& module, bool token_present) + Retrieve available slot ids by calling this static method. + The parameter ``token_present`` controls whether all slots or only slots with a token attached are returned by this method. This method calls :cpp:func:`C_GetSlotList()`. -Further methods: - .. cpp:function:: SlotInfo get_slot_info() const Returns information about the slot. Calls :cpp:func:`C_GetSlotInfo`. @@ -266,7 +264,7 @@ Further methods: .. cpp:function:: void initialize(const std::string& label, const secure_string& so_pin) const - Calls :cpp:func:`C_InitToken` to initialize the token. The :cpp:func:`label` must not exceed 32 bytes. + Calls :cpp:func:`C_InitToken` to initialize the token. The ``label`` must not exceed 32 bytes. The current PIN of the security officer must be passed in ``so_pin`` if the token is reinitialized or if it's a factory new token, the ``so_pin`` that is passed will initially be set. @@ -315,8 +313,10 @@ A session is a logical connection between an application and a token. .. cpp:class:: Session -There are two constructors to create a new session and one constructor to take ownership -of an existing session. + There are two constructors to create a new session and one constructor to + take ownership of an existing session. The destructor calls + :cpp:func:`C_Logout` if a user is logged in to this session and always + :cpp:func:`C_CloseSession`. .. cpp:function:: Session(Slot& slot, bool read_only) @@ -333,8 +333,6 @@ of an existing session. Takes ownership of an existing session by passing :cpp:class:`Slot` and a session ``handle``. -The destructor calls :cpp:func:`C_Logout` if a user is logged in to this session and always :cpp:func:`C_CloseSession`. - .. cpp:function:: SessionHandle release() Returns the released :cpp:type:`SessionHandle` @@ -1378,7 +1376,6 @@ Test results Error descriptions -.. [1] CKR_TEMPLATE_INCOMPLETE (0xD0=208) .. [2] CKR_ARGUMENTS_BAD (0x7=7) .. [3] CKR_MECHANISM_INVALID (0x70=112) .. [4] CKR_FUNCTION_NOT_SUPPORTED (0x54=84) diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index 1d620fabd..839da3216 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -297,7 +297,7 @@ TLS Clients RandomNumberGenerator& rng, \ const Server_Information& server_info = Server_Information(), \ const Protocol_Version offer_version = Protocol_Version::latest_tls_version(), \ - const std::vector<std::string>& next_protocols = {}, \ + const std::vector<std::string>& next_protocols = std::vector<std::string>(), \ size_t reserved_io_buffer_size = 16*1024 \ ) diff --git a/doc/manual/x509.rst b/doc/manual/x509.rst index f998fc715..72e74b56a 100644 --- a/doc/manual/x509.rst +++ b/doc/manual/x509.rst @@ -457,7 +457,7 @@ set of functions in ``x509path.h`` named ``x509_path_validate``: Usage_Type usage = Usage_Type::UNSPECIFIED, \ std::chrono::system_clock::time_point validation_time = std::chrono::system_clock::now(), \ std::chrono::milliseconds ocsp_timeout = std::chrono::milliseconds(0), \ - const std::vector<std::shared_ptr<const OCSP::Response>>& ocsp_resp = {}) + const std::vector<std::shared_ptr<const OCSP::Response>>& ocsp_resp = std::vector<std::shared_ptr<const OCSP::Response>>()) The last five parameters are optional. ``hostname`` specifies a hostname which is matched against the subject DN in ``end_cert`` according to RFC 6125. @@ -826,7 +826,7 @@ for certificate status information. .. cpp:function:: Certificate_Status_Code check_signature( \ const std::vector<Certificate_Store*>& trust_roots, \ - const std::vector<std::shared_ptr<const X509_Certificate>>& cert_path = {}) const + const std::vector<std::shared_ptr<const X509_Certificate>>& cert_path = const std::vector<std::shared<const X509_Certificate>>()) const Find the issuing certificate of the OCSP response, and check the signature. diff --git a/src/scripts/build_docs.py b/src/scripts/build_docs.py index 92542dd2d..a959c98e2 100755 --- a/src/scripts/build_docs.py +++ b/src/scripts/build_docs.py @@ -175,8 +175,7 @@ def main(args=None): cmds.append(['doxygen', os.path.join(cfg['build_dir'], 'botan.doxy')]) if with_sphinx: - sphinx_build = ['sphinx-build', - '-c', cfg['sphinx_config_dir']] + sphinx_build = ['sphinx-build', '-q', '-c', cfg['sphinx_config_dir']] if sphinx_supports_concurrency(): sphinx_build += ['-j', str(get_concurrency())] |