Add ares_free_data() man page.

2 files changed, 65 insertions, 0 deletions

diff --git a/ares/Makefile.inc b/ares/Makefile.inc
index bf249344b..322785899 100644
--- a/ares/Makefile.inc
+++ b/ares/Makefile.inc
@@ -67,6 +67,7 @@ MANPAGES = ares_cancel.3		\
   ares_expand_name.3			\
   ares_expand_string.3			\
   ares_fds.3				\
+  ares_free_data.3			\
   ares_free_hostent.3			\
   ares_free_string.3			\
   ares_gethostbyaddr.3			\
@@ -102,6 +103,7 @@ HTMLPAGES = ares_cancel.html		\
   ares_expand_name.html			\
   ares_expand_string.html		\
   ares_fds.html				\
+  ares_free_data.html			\
   ares_free_hostent.html		\
   ares_free_string.html			\
   ares_gethostbyaddr.html		\
@@ -137,6 +139,7 @@ PDFPAGES = ares_cancel.pdf		\
   ares_expand_name.pdf			\
   ares_expand_string.pdf		\
   ares_fds.pdf				\
+  ares_free_data.pdf			\
   ares_free_hostent.pdf			\
   ares_free_string.pdf			\
   ares_gethostbyaddr.pdf		\
diff --git a/ares/ares_free_data.3 b/ares/ares_free_data.3
new file mode 100644
index 000000000..c9ec59802
--- /dev/null
+++ b/ares/ares_free_data.3
@@ -0,0 +1,62 @@
+.\" $Id$
+.\"
+.\" Copyright 1998 by the Massachusetts Institute of Technology.
+.\" Copyright (C) 2004-2009 by Daniel Stenberg
+.\"
+.\" Permission to use, copy, modify, and distribute this
+.\" software and its documentation for any purpose and without
+.\" fee is hereby granted, provided that the above copyright
+.\" notice appear in all copies and that both that copyright
+.\" notice and this permission notice appear in supporting
+.\" documentation, and that the name of M.I.T. not be used in
+.\" advertising or publicity pertaining to distribution of the
+.\" software without specific, written prior permission.
+.\" M.I.T. makes no representations about the suitability of
+.\" this software for any purpose.  It is provided "as is"
+.\" without express or implied warranty.
+.\"
+.TH ARES_FREE_DATA 3 "20 Nov 2009"
+.SH NAME
+ares_free_data \- Free data allocated by several c-ares functions
+.SH SYNOPSIS
+.nf
+.B #include <ares.h>
+.PP
+.B void ares_free_data(void *\fIdataptr\fP)
+.PP
+.B cc file.c -lcares
+.fi
+.SH DESCRIPTION
+.PP
+The
+.B ares_free_data(3)
+function frees one or more data structures allocated and returned
+by several c-ares functions. Specifically the data returned by the
+following list of functions must be deallocated using this function.
+.TP 5
+.B ares_parse_srv_reply(3)
+When used to free the data returned by ares_parse_srv_reply(3) this
+will free the whole linked list of ares_srv_reply structures returned
+by ares_parse_srv_reply(3), along with any additional storage
+associated with those structures.
+.TP
+.B ares_parse_txt_reply(3)
+When used to free the data returned by ares_parse_txt_reply(3) this
+will free the whole linked list of ares_txt_reply structures returned
+by ares_parse_txt_reply(3), along with any additional storage
+associated with those structures.
+.SH RETURN VALUE
+The ares_free_data() function does not return a value.
+.SH AVAILABILITY
+This function was first introduced in c-ares version 1.6.1 along with the
+definition of preprocessor symbol \fICARES_HAVE_ARES_FREE_DATA\fP as an
+indication of the availability of this function.
+.SH SEE ALSO
+.BR ares_parse_srv_reply(3),
+.BR ares_parse_txt_reply(3)
+.SH AUTHOR
+Yang Tse
+.PP
+Copyright 1998 by the Massachusetts Institute of Technology.
+.br
+Copyright (C) 2004-2009 by Daniel Stenberg.