summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakub Jelen <jjelen@redhat.com>2019-09-13 14:43:08 +0200
committerJakub Jelen <jjelen@redhat.com>2019-09-16 09:35:32 +0200
commit618b858e49ce48ad3b8a36d75215cf2635af8c16 (patch)
treea4165fa8f5125bf5d1a387716017483e334cba27
parent83fa060cec0f3c062117807b154a18f2db63ef06 (diff)
downloadlibssh-618b858e49ce48ad3b8a36d75215cf2635af8c16.tar.gz
libssh-618b858e49ce48ad3b8a36d75215cf2635af8c16.tar.xz
libssh-618b858e49ce48ad3b8a36d75215cf2635af8c16.zip
sftp: Improve the documentation of sftp_init() and sftp_new()
Fixes: T137 Signed-off-by: Jakub Jelen <jjelen@redhat.com> Reviewed-by: Anderson Toshiyuki Sasaki <ansasaki@redhat.com>
-rw-r--r--include/libssh/sftp.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h
index 774a4bac..bb10cdb8 100644
--- a/include/libssh/sftp.h
+++ b/include/libssh/sftp.h
@@ -201,13 +201,18 @@ struct sftp_statvfs_struct {
};
/**
- * @brief Start a new sftp session.
+ * @brief Creates a new sftp session.
+ *
+ * This function creates a new sftp session and allocates a new sftp channel
+ * with the server inside of the provided ssh session. This function call is
+ * usually followed by the sftp_init(), which initializes SFTP protocol itself.
*
* @param session The ssh session to use.
*
* @return A new sftp session or NULL on error.
*
* @see sftp_free()
+ * @see sftp_init()
*/
LIBSSH_API sftp_session sftp_new(ssh_session session);
@@ -232,7 +237,10 @@ LIBSSH_API sftp_session sftp_new_channel(ssh_session session, ssh_channel channe
LIBSSH_API void sftp_free(sftp_session sftp);
/**
- * @brief Initialize the sftp session with the server.
+ * @brief Initialize the sftp protocol with the server.
+ *
+ * This function involves the SFTP protocol initialization (as described
+ * in the SFTP specification), including the version and extensions negotiation.
*
* @param sftp The sftp session to initialize.
*