From 70d6bd6c6fa7be8256e22195516f74ccc7614ebc Mon Sep 17 00:00:00 2001 From: Simon Josefsson Date: Wed, 13 Oct 2010 15:24:18 +0200 Subject: [PATCH] Add libssh2_free man page and fix typo. --- docs/Makefile.am | 1 + docs/libssh2_free.3 | 19 +++++++++++++++++++ include/libssh2.h | 2 +- 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/libssh2_free.3 diff --git a/docs/Makefile.am b/docs/Makefile.am index 9f905d8..4ed40df 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -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 \ diff --git a/docs/libssh2_free.3 b/docs/libssh2_free.3 new file mode 100644 index 0000000..30176d5 --- /dev/null +++ b/docs/libssh2_free.3 @@ -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 + +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) diff --git a/include/libssh2.h b/include/libssh2.h index 9d1e565..038b61f 100644 --- a/include/libssh2.h +++ b/include/libssh2.h @@ -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 *