lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-12-09 15:41:10 +03:00
Code Activity

options.c: Improve doc of ssh_options_set() and ssh_bind_options_set()

Browse Source 
Text has been added to the documentation of ssh_options_set() and
ssh_bind_options_set() which explains what the third argument (value argument)
should be depending on the option value to set.

Signed-off-by: Eshan Kelkar <eshankelkar@galorithm.com>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
This commit is contained in:
Eshan Kelkar
2024-05-28 10:29:41 +05:30
committed by Jakub Jelen
parent 5802017b7f
commit ac7c788ef0
1 changed files with 31 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
src/options.c
View File

@@ -612,6 +612,21 @@ int ssh_options_set_algo(ssh_session session,
* type set.
*
* @return 0 on success, < 0 on error.
*
* @warning When the option value to set is represented via a pointer
* (e.g const char * in case of strings, ssh_key in case of a
* libssh key), the value parameter should be that pointer.
* Do NOT pass a pointer to a pointer (const char **, ssh_key *)
*
* @warning When the option value to set is not a pointer (e.g int,
* unsigned int, bool, long), the value parameter should be
* a pointer to the location storing the value to set (int *,
* unsigned int *, bool *, long *)
*
* @warning If the value parameter has an invalid type (e.g if its not a
* pointer when it should have been a pointer, or if its a pointer
* to a pointer when it should have just been a pointer), then the
* behaviour is undefined.
*/
int ssh_options_set(ssh_session session, enum ssh_options_e type,
const void *value)
@@ -2130,6 +2145,22 @@ static int ssh_bind_set_algo(ssh_bind sshbind,
*
* @return 0 on success, < 0 on error, invalid option, or
* parameter.
*
* @warning When the option value to set is represented via a
* pointer (e.g const char * in case of strings, ssh_key
* in case of a libssh key), the value parameter should be
* that pointer. Do NOT pass a pointer to a pointer (const
* char **, ssh_key *)
*
* @warning When the option value to set is not a pointer (e.g int,
* unsigned int, bool, long), the value parameter should be
* a pointer to the location storing the value to set (int
* *, unsigned int *, bool *, long *)
*
* @warning If the value parameter has an invalid type (e.g if its
* not a pointer when it should have been a pointer, or if
* its a pointer to a pointer when it should have just been
* a pointer), then the behaviour is undefined.
*/
int
ssh_bind_options_set(ssh_bind sshbind,