[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] pki.c: ssh_pki_export_privkey_to_pubkey: fixed documentation about return value.


From 7bea4083f32b9ca7bbc0a72deb13110affebb872 Mon Sep 17 00:00:00 2001
From: Younes Serraj <younes.serraj@xxxxxxxxx>
Date: Sun, 24 Jan 2016 18:34:15 +0100
Subject: [PATCH] pki.c: ssh_pki_export_privkey_to_pubkey: fixed documentation
 about return value.

Documentation now is congruent with the code:
- SSH_OK is returned on success,
- SSH_ERROR is returned on error.

Signed-off-by: Younes Serraj <younes.serraj@xxxxxxxxx>
---
 src/pki.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/pki.c b/src/pki.c
index d940ca4..8d82f8d 100644
--- a/src/pki.c
+++ b/src/pki.c
@@ -1222,7 +1222,7 @@ error:
  * @param[out] pkey     A pointer to store the newly allocated public key. You
  *                      NEED to free the key.
  *
- * @return              A public key, NULL on error.
+ * @return              SSH_OK on success, SSH_ERROR on error.
  *
  * @see ssh_key_free()
  */
-- 
2.7.0.rc3


Archive administrator: postmaster@lists.cynapses.org