From 898be61fc6639dc180efbacb8a1f9bef6f9d17f3 Mon Sep 17 00:00:00 2001 From: Younes Serraj Date: Mon, 18 Jan 2016 18:03:33 +0000 Subject: [PATCH] auth: Remove references to ssh_userauth_pubkey in documentation - replaced references to ssh_userauth_pubkey (legacy function) by ssh_userauth_publickey. - added missing \n in a couple of Returns sections. This patch is an answer to this discussion: http://www.libssh.org/archive/libssh/2016-01/0000009.html Signed-off-by: Younes Serraj Reviewed-by: Andreas Schneider --- src/auth.c | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/src/auth.c b/src/auth.c index 611660b4..81395f87 100644 --- a/src/auth.c +++ b/src/auth.c @@ -430,7 +430,7 @@ fail: * SSH_AUTH_PARTIAL: You've been partially authenticated, you still * have to use another method.\n * SSH_AUTH_SUCCESS: The public key is accepted, you want now to use - * ssh_userauth_publickey(). + * ssh_userauth_publickey().\n * SSH_AUTH_AGAIN: In nonblocking mode, you've got to call this again * later. * @@ -538,8 +538,7 @@ fail: * method.\n * SSH_AUTH_PARTIAL: You've been partially authenticated, you still * have to use another method.\n - * SSH_AUTH_SUCCESS: The public key is accepted, you want now to use - * ssh_userauth_pubkey(). + * SSH_AUTH_SUCCESS: The public key is accepted.\n * SSH_AUTH_AGAIN: In nonblocking mode, you've got to call this again * later. * @@ -577,7 +576,7 @@ int ssh_userauth_publickey(ssh_session session, default: ssh_set_error(session, SSH_FATAL, - "Bad call during pending SSH call in ssh_userauth_try_pubkey"); + "Bad call during pending SSH call in ssh_userauth_try_publickey"); return SSH_AUTH_ERROR; } @@ -660,7 +659,7 @@ static int ssh_userauth_agent_publickey(ssh_session session, default: ssh_set_error(session, SSH_FATAL, - "Bad call during pending SSH call in ssh_userauth_try_pubkey"); + "Bad call during pending SSH call in ssh_userauth_try_publickey"); return SSH_ERROR; } @@ -755,7 +754,7 @@ struct ssh_agent_state_struct { * SSH_AUTH_PARTIAL: You've been partially authenticated, you still * have to use another method.\n * SSH_AUTH_SUCCESS: The public key is accepted, you want now to use - * ssh_userauth_pubkey(). + * ssh_userauth_publickey().\n * SSH_AUTH_AGAIN: In nonblocking mode, you've got to call this again * later. * @@ -882,7 +881,7 @@ struct ssh_auth_auto_state_struct { * SSH_AUTH_PARTIAL: You've been partially authenticated, you still * have to use another method.\n * SSH_AUTH_SUCCESS: The public key is accepted, you want now to use - * ssh_userauth_pubkey(). + * ssh_userauth_publickey().\n * SSH_AUTH_AGAIN: In nonblocking mode, you've got to call this again * later. *