summary refs log tree commit diff stats
path: root/include/crypto/tlssession.h
diff options
context:
space:
mode:
authorDaniel P. Berrange <berrange@redhat.com>2016-01-13 12:22:33 +0000
committerDaniel P. Berrange <berrange@redhat.com>2016-02-01 14:11:35 +0000
commit07982d2ee9a57bf4f04fc18f77f0f56fa9a33c08 (patch)
treea3c652a94b7516767c6e247337bad4b512741877 /include/crypto/tlssession.h
parent0430891ce162b986c6e02a7729a942ecd2a32ca4 (diff)
downloadfocaccia-qemu-07982d2ee9a57bf4f04fc18f77f0f56fa9a33c08.tar.gz
focaccia-qemu-07982d2ee9a57bf4f04fc18f77f0f56fa9a33c08.zip
crypto: fix description of @errp parameter initialization
The "Error **errp" parameters must be NULL initialized
not uninitialized.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Diffstat (limited to 'include/crypto/tlssession.h')
-rw-r--r--include/crypto/tlssession.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/crypto/tlssession.h b/include/crypto/tlssession.h
index d356a8dc17..c1bad9e4f0 100644
--- a/include/crypto/tlssession.h
+++ b/include/crypto/tlssession.h
@@ -114,7 +114,7 @@ typedef struct QCryptoTLSSession QCryptoTLSSession;
  * @hostname: optional hostname to validate
  * @aclname: optional ACL to validate peer credentials against
  * @endpoint: role of the TLS session, client or server
- * @errp: pointer to an uninitialized error object
+ * @errp: pointer to a NULL-initialized error object
  *
  * Create a new TLS session object that will be used to
  * negotiate a TLS session over an arbitrary data channel.
@@ -163,7 +163,7 @@ void qcrypto_tls_session_free(QCryptoTLSSession *sess);
 /**
  * qcrypto_tls_session_check_credentials:
  * @sess: the TLS session object
- * @errp: pointer to an uninitialized error object
+ * @errp: pointer to a NULL-initialized error object
  *
  * Validate the peer's credentials after a successful
  * TLS handshake. It is an error to call this before
@@ -249,7 +249,7 @@ ssize_t qcrypto_tls_session_read(QCryptoTLSSession *sess,
 /**
  * qcrypto_tls_session_handshake:
  * @sess: the TLS session object
- * @errp: pointer to an uninitialized error object
+ * @errp: pointer to a NULL-initialized error object
  *
  * Start, or continue, a TLS handshake sequence. If
  * the underlying data channel is non-blocking, then
@@ -292,7 +292,7 @@ qcrypto_tls_session_get_handshake_status(QCryptoTLSSession *sess);
 /**
  * qcrypto_tls_session_get_key_size:
  * @sess: the TLS session object
- * @errp: pointer to an uninitialized error object
+ * @errp: pointer to a NULL-initialized error object
  *
  * Check the size of the data channel encryption key
  *