From ba79d6b52de6d2a87fe26e027095b2fb29f54207 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Fri, 26 Dec 2008 07:37:55 +0000 Subject: [PATCH] libssh2_base64_decode is deprecated and subject for removal in a future version (like on the next soname bump) --- docs/libssh2_base64_decode.3 | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/libssh2_base64_decode.3 b/docs/libssh2_base64_decode.3 index 7909ded..7c9c5f0 100644 --- a/docs/libssh2_base64_decode.3 +++ b/docs/libssh2_base64_decode.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_base64_decode.3,v 1.1 2008/12/23 13:23:45 bagder Exp $ +.\" $Id: libssh2_base64_decode.3,v 1.2 2008/12/26 07:37:55 bagder Exp $ .\" .TH libssh2_base64_decode 3 "23 Dec 2008" "libssh2 1.0" "libssh2 manual" .SH NAME @@ -10,12 +10,15 @@ int libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest, unsigned int *dest_len, const char *src, unsigned int src_len); .SH DESCRIPTION +This function is deemed DEPRECATED and will be removed from libssh2 in a +future version. Don't use it! + Decode a base64 chunk and store it into a newly allocated buffer. 'dest_len' will be set to hold the length of the returned buffer that '*dest' will point to. -NOTE: the returned buffer is allocated by this function, but it is not clear -how that memory is freed! +The returned buffer is allocated by this function, but it is not clear how to +free that memory! .SH BUGS The memory that *dest points to is allocated by the malloc function libssh2 uses, but there's no way for an appliction to free this data in a safe and