summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-12-12 12:52:13 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-12-12 12:52:13 +0000
commitfcebc510571b41b8e5cb4abebca165b624db53be (patch)
tree6b0a719558476bc50303df1029e9a0575837a0b4 /lib
parent6b24d521ba3db74ba27aeb9526343a42a0af2440 (diff)
Document DIRECTORYSTRING_new(3), DIRECTORYSTRING_free(3),
DISPLAYTEXT_new(3), DISPLAYTEXT_free(3). These functions are clearly public because OpenSSL documents them and they are in the public <openssl/asn1.h> header. OpenSSL documents these four functions in doc/man3/X509_dup.pod [sic], but the information given is completely wrong: wrong header file, wrong prototypes, misleading description. Why, oh why do people even bother to write documentation if nothing of what they write is true?
Diffstat (limited to 'lib')
-rw-r--r--lib/libcrypto/man/ASN1_STRING_new.338
1 files changed, 32 insertions, 6 deletions
diff --git a/lib/libcrypto/man/ASN1_STRING_new.3 b/lib/libcrypto/man/ASN1_STRING_new.3
index 099d5d7b980..75c5049a148 100644
--- a/lib/libcrypto/man/ASN1_STRING_new.3
+++ b/lib/libcrypto/man/ASN1_STRING_new.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ASN1_STRING_new.3,v 1.5 2016/11/10 11:50:32 schwarze Exp $
+.\" $OpenBSD: ASN1_STRING_new.3,v 1.6 2016/12/12 12:52:12 schwarze Exp $
.\" OpenSSL 99d63d46 Tue Mar 24 07:52:24 2015 -0400
.\"
.\" This file was written by Dr. Stephen Henson.
@@ -48,13 +48,17 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: November 10 2016 $
+.Dd $Mdocdate: December 12 2016 $
.Dt ASN1_STRING_NEW 3
.Os
.Sh NAME
.Nm ASN1_STRING_new ,
.Nm ASN1_STRING_type_new ,
.Nm ASN1_STRING_free
+.Nm DIRECTORYSTRING_new ,
+.Nm DIRECTORYSTRING_free ,
+.Nm DISPLAYTEXT_new ,
+.Nm DISPLAYTEXT_free
.Nd ASN1_STRING allocation functions
.Sh SYNOPSIS
.In openssl/asn1.h
@@ -70,9 +74,28 @@
.Fo ASN1_STRING_free
.Fa "ASN1_STRING *a"
.Fc
+.Ft ASN1_STRING *
+.Fo DIRECTORYSTRING_new
+.Fa void
+.Fc
+.Ft void
+.Fo DIRECTORYSTRING_free
+.Fa "ASN1_STRING *a"
+.Fc
+.Ft ASN1_STRING *
+.Fo DISPLAYTEXT_new
+.Fa void
+.Fc
+.Ft void
+.Fo DISPLAYTEXT_free
+.Fa "ASN1_STRING *a"
+.Fc
.Sh DESCRIPTION
-.Fn ASN1_STRING_new
-returns an allocated
+.Fn ASN1_STRING_new ,
+.Fn DIRECTORYSTRING_new ,
+and
+.Fn DISPLAYTEXT_new
+return an allocated
.Vt ASN1_STRING
structure.
Its type is undefined.
@@ -83,8 +106,11 @@ returns an allocated
structure of type
.Fa type .
.Pp
-.Fn ASN1_STRING_free
-frees up
+.Fn ASN1_STRING_free ,
+.Fn DIRECTORYSTRING_free ,
+and
+.Fn DISPLAYTEXT_free
+free up
.Fa a .
If
.Fa a