summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorschwarze <>2016-12-12 12:52:12 +0000
committerschwarze <>2016-12-12 12:52:12 +0000
commit47a9d788ec3f940f8a3f9a45e024083d4f9fc702 (patch)
treeb819b5324feb28b4940d27279773847fb979bf49 /src/lib
parentf38b80a25989f438feba1b384061f8cf8c444059 (diff)
downloadopenbsd-47a9d788ec3f940f8a3f9a45e024083d4f9fc702.tar.gz
openbsd-47a9d788ec3f940f8a3f9a45e024083d4f9fc702.tar.bz2
openbsd-47a9d788ec3f940f8a3f9a45e024083d4f9fc702.zip
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 'src/lib')
-rw-r--r--src/lib/libcrypto/man/ASN1_STRING_new.338
1 files changed, 32 insertions, 6 deletions
diff --git a/src/lib/libcrypto/man/ASN1_STRING_new.3 b/src/lib/libcrypto/man/ASN1_STRING_new.3
index 099d5d7b98..75c5049a14 100644
--- a/src/lib/libcrypto/man/ASN1_STRING_new.3
+++ b/src/lib/libcrypto/man/ASN1_STRING_new.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: ASN1_STRING_new.3,v 1.5 2016/11/10 11:50:32 schwarze Exp $ 1.\" $OpenBSD: ASN1_STRING_new.3,v 1.6 2016/12/12 12:52:12 schwarze Exp $
2.\" OpenSSL 99d63d46 Tue Mar 24 07:52:24 2015 -0400 2.\" OpenSSL 99d63d46 Tue Mar 24 07:52:24 2015 -0400
3.\" 3.\"
4.\" This file was written by Dr. Stephen Henson. 4.\" This file was written by Dr. Stephen Henson.
@@ -48,13 +48,17 @@
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\" 50.\"
51.Dd $Mdocdate: November 10 2016 $ 51.Dd $Mdocdate: December 12 2016 $
52.Dt ASN1_STRING_NEW 3 52.Dt ASN1_STRING_NEW 3
53.Os 53.Os
54.Sh NAME 54.Sh NAME
55.Nm ASN1_STRING_new , 55.Nm ASN1_STRING_new ,
56.Nm ASN1_STRING_type_new , 56.Nm ASN1_STRING_type_new ,
57.Nm ASN1_STRING_free 57.Nm ASN1_STRING_free
58.Nm DIRECTORYSTRING_new ,
59.Nm DIRECTORYSTRING_free ,
60.Nm DISPLAYTEXT_new ,
61.Nm DISPLAYTEXT_free
58.Nd ASN1_STRING allocation functions 62.Nd ASN1_STRING allocation functions
59.Sh SYNOPSIS 63.Sh SYNOPSIS
60.In openssl/asn1.h 64.In openssl/asn1.h
@@ -70,9 +74,28 @@
70.Fo ASN1_STRING_free 74.Fo ASN1_STRING_free
71.Fa "ASN1_STRING *a" 75.Fa "ASN1_STRING *a"
72.Fc 76.Fc
77.Ft ASN1_STRING *
78.Fo DIRECTORYSTRING_new
79.Fa void
80.Fc
81.Ft void
82.Fo DIRECTORYSTRING_free
83.Fa "ASN1_STRING *a"
84.Fc
85.Ft ASN1_STRING *
86.Fo DISPLAYTEXT_new
87.Fa void
88.Fc
89.Ft void
90.Fo DISPLAYTEXT_free
91.Fa "ASN1_STRING *a"
92.Fc
73.Sh DESCRIPTION 93.Sh DESCRIPTION
74.Fn ASN1_STRING_new 94.Fn ASN1_STRING_new ,
75returns an allocated 95.Fn DIRECTORYSTRING_new ,
96and
97.Fn DISPLAYTEXT_new
98return an allocated
76.Vt ASN1_STRING 99.Vt ASN1_STRING
77structure. 100structure.
78Its type is undefined. 101Its type is undefined.
@@ -83,8 +106,11 @@ returns an allocated
83structure of type 106structure of type
84.Fa type . 107.Fa type .
85.Pp 108.Pp
86.Fn ASN1_STRING_free 109.Fn ASN1_STRING_free ,
87frees up 110.Fn DIRECTORYSTRING_free ,
111and
112.Fn DISPLAYTEXT_free
113free up
88.Fa a . 114.Fa a .
89If 115If
90.Fa a 116.Fa a