generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add libssh2_free man page and fix typo.

Browse Source
This commit is contained in:
Simon Josefsson 2010-10-13 15:24:18 +02:00
parent 98e38c4f3a
commit 70d6bd6c6f
3 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/Makefile.am
View File

@ -59,6 +59,7 @@ dist_man_MANS = \
libssh2_channel_x11_req.3 \
libssh2_channel_x11_req_ex.3 \
libssh2_exit.3 \
libssh2_free.3 \
libssh2_free_host_entry.3 \
libssh2_host_entry_match.3 \
libssh2_hostkey_hash.3 \

19
docs/libssh2_free.3 Normal file
View File

@ -0,0 +1,19 @@
.TH libssh2_exit 3 "13 Oct 2010" "libssh2 1.2.8" "libssh2 manual"
.SH NAME
libssh2_free - deallocate libssh2 memory
.SH SYNOPSIS
#include <libssh2.h>
void
libssh2_free(LIBSSH2_SESSION *session, void *ptr);
.SH DESCRIPTION
Deallocate memory allocated by earlier call to libssh2 functions. It
uses the memory allocation callbacks provided by the application, if
any. Otherwise, this will just call free().
This function is mostly useful under Windows when libssh2 is linked to
one run-time library and the application to another.
.SH AVAILABILITY
Added in libssh2 1.2.8
.SH SEE ALSO
.BR libssh2_session_init_ex(3)

2
include/libssh2.h
View File

@ -425,7 +425,7 @@ LIBSSH2_API void libssh2_exit(void);
*
* Deallocate memory allocated by earlier call to libssh2 functions.
*/
LIBSSH2_API void libssh2_free(LIBSSH2_SESSION *session, void *ptr)
LIBSSH2_API void libssh2_free(LIBSSH2_SESSION *session, void *ptr);
/* Session API */
LIBSSH2_API LIBSSH2_SESSION *