[Pkg-privacy-commits] [libotr] 55/225: Slightly better documentation for the otrl_message_symkey function.

[Ximin Luo]

This is an automated email from the git hooks/post-receive script.

infinity0 pushed a commit to branch master
in repository libotr.

commit 4030eff89263030203964e0e807beb7d1acc3b45
Author: cypherpunk <cypherpunk>
Date:   Wed Jul 2 18:37:07 2008 +0000

    Slightly better documentation for the otrl_message_symkey function.
---
 src/message.c | 4 +++-
 src/message.h | 4 +++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/message.c b/src/message.c
index b2286a2..c61cd13 100644
--- a/src/message.c
+++ b/src/message.c
@@ -1625,7 +1625,9 @@ void otrl_message_disconnect(OtrlUserState us, const OtrlMessageAppOps *ops,
 }
 
 /* Get the current extra symmetric key (of size OTRL_EXTRAKEY_BYTES
- * bytes) and let the other side know what we're going to use it for. */
+ * bytes) and let the other side know what we're going to use it for.
+ * The key is stored in symkey, which must already be allocated
+ * and OTRL_EXTRAKEY_BYTES bytes long. */
 gcry_error_t otrl_message_symkey(OtrlUserState us,
 	const OtrlMessageAppOps *ops, void *opdata, ConnContext *context,
 	unsigned int use, const unsigned char *usedata, size_t usedatalen,
diff --git a/src/message.h b/src/message.h
index 7fda2d1..c3b60e1 100644
--- a/src/message.h
+++ b/src/message.h
@@ -234,7 +234,9 @@ void otrl_message_abort_smp(OtrlUserState us, const OtrlMessageAppOps *ops,
 	void *opdata, ConnContext *context);
 
 /* Get the current extra symmetric key (of size OTRL_EXTRAKEY_BYTES
- * bytes) and let the other side know what we're going to use it for. */
+ * bytes) and let the other side know what we're going to use it for.
+ * The key is stored in symkey, which must already be allocated
+ * and OTRL_EXTRAKEY_BYTES bytes long. */
 gcry_error_t otrl_message_symkey(OtrlUserState us,
 	const OtrlMessageAppOps *ops, void *opdata, ConnContext *context,
 	unsigned int use, const unsigned char *usedata, size_t usedatalen,

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/libotr.git