aboutsummaryrefslogtreecommitdiff
path: root/libssh
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-09-15 18:06:19 +0200
committerAndreas Schneider <mail@cynapses.org>2009-09-15 18:06:19 +0200
commitd37a475816d7a665f21cf8cace693518059da3af (patch)
tree951525df4d2ce57435966c3e418bfa7adb898f62 /libssh
parent48456426112eefd3a852138d9c9e3eb4cf84d29b (diff)
downloadlibssh-d37a475816d7a665f21cf8cace693518059da3af.tar.gz
libssh-d37a475816d7a665f21cf8cace693518059da3af.tar.xz
libssh-d37a475816d7a665f21cf8cace693518059da3af.zip
Improve documentation of ssh_options_parse_config().
Diffstat (limited to 'libssh')
-rw-r--r--libssh/options.c7
1 files changed, 5 insertions, 2 deletions
diff --git a/libssh/options.c b/libssh/options.c
index 5d21408a..755ef505 100644
--- a/libssh/options.c
+++ b/libssh/options.c
@@ -1021,8 +1021,9 @@ int ssh_options_set_auth_callback(SSH_OPTIONS *opt, ssh_auth_callback cb,
/**
* @brief Parse the ssh config file.
*
- * This must be the last call of all options, it may overwrite options which
- * are already set. It requires at least the hostname to be set.
+ * This should be the last call of all options, it may overwrite options which
+ * are already set. It requires that the host name is already set with
+ * ssh_options_set_host().
*
* @param opt The options structure to use.
*
@@ -1030,6 +1031,8 @@ int ssh_options_set_auth_callback(SSH_OPTIONS *opt, ssh_auth_callback cb,
* ~/.ssh/config will be used.
*
* @return 0 on success, < 0 on error.
+ *
+ * @see ssh_options_set_host()
*/
int ssh_options_parse_config(ssh_options opt, const char *filename) {
char buffer[1024] = {0};