Merge branch 'wip/dueno/doc-fixes' into 'master'

x509: clarify how to release memory allocated for DN

Closes #1110

See merge request gnutls/gnutls!1359

3 files changed, 8 insertions, 8 deletions

diff --git a/lib/x509/crl.c b/lib/x509/crl.c
index 76d90925e8..8705be3b6c 100644
--- a/lib/x509/crl.c
+++ b/lib/x509/crl.c
@@ -300,7 +300,7 @@ gnutls_x509_crl_get_dn_oid(gnutls_x509_crl_t crl,
 /**
  * gnutls_x509_crl_get_issuer_dn2:
  * @crl: should contain a #gnutls_x509_crl_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  *
  * This function will allocate buffer and copy the name of the CRL issuer.
  * The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as
@@ -331,7 +331,7 @@ gnutls_x509_crl_get_issuer_dn2(gnutls_x509_crl_t crl, gnutls_datum_t * dn)
 /**
  * gnutls_x509_crl_get_issuer_dn3:
  * @crl: should contain a #gnutls_x509_crl_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  * @flags: zero or %GNUTLS_X509_DN_FLAG_COMPAT
  *
  * This function will allocate buffer and copy the name of the CRL issuer.
diff --git a/lib/x509/crq.c b/lib/x509/crq.c
index afebca2012..3cb2d1c418 100644
--- a/lib/x509/crq.c
+++ b/lib/x509/crq.c
@@ -284,7 +284,7 @@ gnutls_x509_crq_get_dn(gnutls_x509_crq_t crq, char *buf, size_t * buf_size)
 /**
  * gnutls_x509_crq_get_dn2:
  * @crq: should contain a #gnutls_x509_crq_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  *
  * This function will allocate buffer and copy the name of the Certificate 
  * request. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as
@@ -314,7 +314,7 @@ int gnutls_x509_crq_get_dn2(gnutls_x509_crq_t crq, gnutls_datum_t * dn)
 /**
  * gnutls_x509_crq_get_dn3:
  * @crq: should contain a #gnutls_x509_crq_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  * @flags: zero or %GNUTLS_X509_DN_FLAG_COMPAT
  *
  * This function will allocate buffer and copy the name of the Certificate 
diff --git a/lib/x509/x509.c b/lib/x509/x509.c
index c713f857a0..e9e5423da2 100644
--- a/lib/x509/x509.c
+++ b/lib/x509/x509.c
@@ -704,7 +704,7 @@ gnutls_x509_crt_get_issuer_dn(gnutls_x509_crt_t cert, char *buf,
 /**
  * gnutls_x509_crt_get_issuer_dn2:
  * @cert: should contain a #gnutls_x509_crt_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  *
  * This function will allocate buffer and copy the name of issuer of the Certificate.
  * The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as
@@ -735,7 +735,7 @@ gnutls_x509_crt_get_issuer_dn2(gnutls_x509_crt_t cert, gnutls_datum_t * dn)
 /**
  * gnutls_x509_crt_get_issuer_dn3:
  * @cert: should contain a #gnutls_x509_crt_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  * @flags: zero or %GNUTLS_X509_DN_FLAG_COMPAT
  *
  * This function will allocate buffer and copy the name of issuer of the Certificate.
@@ -888,7 +888,7 @@ gnutls_x509_crt_get_dn(gnutls_x509_crt_t cert, char *buf,
 /**
  * gnutls_x509_crt_get_dn2:
  * @cert: should contain a #gnutls_x509_crt_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  *
  * This function will allocate buffer and copy the name of the Certificate.
  * The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as
@@ -918,7 +918,7 @@ int gnutls_x509_crt_get_dn2(gnutls_x509_crt_t cert, gnutls_datum_t * dn)
 /**
  * gnutls_x509_crt_get_dn3:
  * @cert: should contain a #gnutls_x509_crt_t type
- * @dn: a pointer to a structure to hold the name
+ * @dn: a pointer to a structure to hold the name; must be freed using gnutls_free()
  * @flags: zero or %GNUTLS_X509_DN_FLAG_COMPAT
  *
  * This function will allocate buffer and copy the name of the Certificate.