Re: ssh_options_set value param outdated

[g4-lisz@xxxxxxxxxxxx]

On 24.01.19 17:12, Andreas Schneider wrote:
> On Thursday, 24 January 2019 13:45:49 CET g4-lisz@xxxxxxxxxxxx wrote:
>> On 20.01.19 14:41, g4-lisz@xxxxxxxxxxxx wrote:
>>> Hi there
>>>
>>> In options.c for function ssh_options_set(), the value @param annotation
>>> is outdated:
>>>
>>>  *              - SSH_OPTIONS_LOG_CALLBACK:
>>>  *                Set a callback to use your own logging function
>>>  *                (function pointer).
>>>  *
>>>  *              - SSH_OPTIONS_LOG_USERDATA:
>>>  *                Set the user data passed to the logging function
>>>  *                (generic pointer).
>>>
>>> Logging callback and logging useradata is outdated and is not treated
>>> anywhere in options.c
>>>
>>> But it still get's its way into the documentation, so this is confusing.
>> Ok... Should I submit a patch? But I'm really new to Git, and things are
>> quite confusing for a SVN user.
> Yes, please create a patch. The way it works is normally:

If found some more "lost" options.

SSH_OPTIONS_AUTH_CALLBACK
SSH_OPTIONS_AUTH_USERDATA
SSH_OPTIONS_LOG_CALLBACK
SSH_OPTIONS_LOG_USERDATA
SSH_OPTIONS_STATUS_CALLBACK
SSH_OPTIONS_STATUS_ARG

Patch is atatched.

Till

From d123b30e1a6d8d1f5174fef0065673ce24b5ee37 Mon Sep 17 00:00:00 2001
From: Till Wimmer <twimmer@xxxxxxxxxxxxxxx>
Date: Thu, 24 Jan 2019 19:09:20 +0100
Subject: [PATCH] Removed outdated param annotations of ssh_options_set()

Signed-off-by: Till Wimmer <twimmer@xxxxxxxxxxxxxxx>
---
 src/options.c | 31 -------------------------------
 1 file changed, 31 deletions(-)

diff --git a/src/options.c b/src/options.c
index 23ffd46..33657fd 100644
--- a/src/options.c
+++ b/src/options.c
@@ -350,37 +350,6 @@ int ssh_options_set_algo(ssh_session session,
  *                \n
  *                See the corresponding numbers in libssh.h.
  *
- *              - SSH_OPTIONS_AUTH_CALLBACK:
- *                Set a callback to use your own authentication function
- *                (function pointer).
- *
- *              - SSH_OPTIONS_AUTH_USERDATA:
- *                Set the user data passed to the authentication
- *                function (generic pointer).
- *
- *              - SSH_OPTIONS_LOG_CALLBACK:
- *                Set a callback to use your own logging function
- *                (function pointer).
- *
- *              - SSH_OPTIONS_LOG_USERDATA:
- *                Set the user data passed to the logging function
- *                (generic pointer).
- *
- *              - SSH_OPTIONS_STATUS_CALLBACK:
- *                Set a callback to show connection status in realtime
- *                (function pointer).\n
- *                \n
- *                @code
- *                fn(void *arg, float status)
- *                @endcode
- *                \n
- *                During ssh_connect(), libssh will call the callback
- *                with status from 0.0 to 1.0.
- *
- *              - SSH_OPTIONS_STATUS_ARG:
- *                Set the status argument which should be passed to the
- *                status callback (generic pointer).
- *
  *              - SSH_OPTIONS_CIPHERS_C_S:
  *                Set the symmetric cipher client to server (const char *,
  *                comma-separated list).
-- 
2.7.4