From 07982d2ee9a57bf4f04fc18f77f0f56fa9a33c08 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Wed, 13 Jan 2016 12:22:33 +0000 Subject: [PATCH] crypto: fix description of @errp parameter initialization The "Error **errp" parameters must be NULL initialized not uninitialized. Signed-off-by: Daniel P. Berrange --- include/crypto/cipher.h | 8 ++++---- include/crypto/hash.h | 12 ++++++------ include/crypto/tlssession.h | 8 ++++---- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/include/crypto/cipher.h b/include/crypto/cipher.h index a812803..f90ac79 100644 --- a/include/crypto/cipher.h +++ b/include/crypto/cipher.h @@ -138,7 +138,7 @@ size_t qcrypto_cipher_get_iv_len(QCryptoCipherAlgorithm alg, * @mode: the cipher usage mode * @key: the private key bytes * @nkey: the length of @key - * @errp: pointer to an uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Creates a new cipher object for encrypting/decrypting * data with the algorithm @alg in the usage mode @mode. @@ -174,7 +174,7 @@ void qcrypto_cipher_free(QCryptoCipher *cipher); * @in: buffer holding the plain text input data * @out: buffer to fill with the cipher text output data * @len: the length of @in and @out buffers - * @errp: pointer to an uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Encrypts the plain text stored in @in, filling * @out with the resulting ciphered text. Both the @@ -196,7 +196,7 @@ int qcrypto_cipher_encrypt(QCryptoCipher *cipher, * @in: buffer holding the cipher text input data * @out: buffer to fill with the plain text output data * @len: the length of @in and @out buffers - * @errp: pointer to an uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Decrypts the cipher text stored in @in, filling * @out with the resulting plain text. Both the @@ -216,7 +216,7 @@ int qcrypto_cipher_decrypt(QCryptoCipher *cipher, * @cipher: the cipher object * @iv: the initialization vector bytes * @niv: the length of @iv - * @errpr: pointer to an uninitialized error object + * @errpr: pointer to a NULL-initialized error object * * If the @cipher object is setup to use a mode that requires * initialization vectors, this sets the initialization vector diff --git a/include/crypto/hash.h b/include/crypto/hash.h index 41822c0..5e8d9a1 100644 --- a/include/crypto/hash.h +++ b/include/crypto/hash.h @@ -55,7 +55,7 @@ size_t qcrypto_hash_digest_len(QCryptoHashAlgorithm alg); * @niov: the length of @iov * @result: pointer to hold output hash * @resultlen: pointer to hold length of @result - * @errp: pointer to uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Computes the hash across all the memory regions * present in @iov. The @result pointer will be @@ -80,7 +80,7 @@ int qcrypto_hash_bytesv(QCryptoHashAlgorithm alg, * @len: the length of @buf * @result: pointer to hold output hash * @resultlen: pointer to hold length of @result - * @errp: pointer to uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Computes the hash across all the memory region * @buf of length @len. The @result pointer will be @@ -104,7 +104,7 @@ int qcrypto_hash_bytes(QCryptoHashAlgorithm alg, * @iov: the array of memory regions to hash * @niov: the length of @iov * @digest: pointer to hold output hash - * @errp: pointer to uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Computes the hash across all the memory regions * present in @iov. The @digest pointer will be @@ -127,7 +127,7 @@ int qcrypto_hash_digestv(QCryptoHashAlgorithm alg, * @buf: the memory region to hash * @len: the length of @buf * @digest: pointer to hold output hash - * @errp: pointer to uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Computes the hash across all the memory region * @buf of length @len. The @digest pointer will be @@ -150,7 +150,7 @@ int qcrypto_hash_digest(QCryptoHashAlgorithm alg, * @iov: the array of memory regions to hash * @niov: the length of @iov * @base64: pointer to hold output hash - * @errp: pointer to uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Computes the hash across all the memory regions * present in @iov. The @base64 pointer will be @@ -173,7 +173,7 @@ int qcrypto_hash_base64v(QCryptoHashAlgorithm alg, * @buf: the memory region to hash * @len: the length of @buf * @base64: pointer to hold output hash - * @errp: pointer to uninitialized error object + * @errp: pointer to a NULL-initialized error object * * Computes the hash across all the memory region * @buf of length @len. The @base64 pointer will be diff --git a/include/crypto/tlssession.h b/include/crypto/tlssession.h index d356a8d..c1bad9e 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 * -- 2.7.4