libssh2_base64_decode is deprecated and subject for removal in a future

version (like on the next soname bump)

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