Remove ASN1_buf_print documentation

This function will be made internal-only and likely be renamed/rewritten.
author: tb <> 2023-07-21 04:50:47 +0000
committer: tb <> 2023-07-21 04:50:47 +0000
commit: c8e14d21085a5664fe144bcce79739faa47cd45b (patch)
tree: 0fdaa156ccc7316bb322a7b0aff921dae6eee27b /src/lib
parent: 1c53257d4d340391ea806d02ce30e0f61c72d1b7 (diff)
download: openbsd-c8e14d21085a5664fe144bcce79739faa47cd45b.tar.gz
openbsd-c8e14d21085a5664fe144bcce79739faa47cd45b.tar.bz2
openbsd-c8e14d21085a5664fe144bcce79739faa47cd45b.zip
3 files changed, 3 insertions, 74 deletions
diff --git a/src/lib/libcrypto/man/ASN1_buf_print.3 b/src/lib/libcrypto/man/ASN1_buf_print.3
deleted file mode 100644
index 67b39bea70..0000000000
--- a/src/lib/libcrypto/man/ASN1_buf_print.3
+++ /dev/null
@@ -1,69 +0,0 @@
-.\" $OpenBSD: ASN1_buf_print.3,v 1.2 2023/07/09 06:45:03 tb Exp $
-.\"
-.\" Copyright (c) 2022 Ingo Schwarze <schwarze@openbsd.org>
-.\"
-.\" Permission to use, copy, modify, and distribute this software for any
-.\" purpose with or without fee is hereby granted, provided that the above
-.\" copyright notice and this permission notice appear in all copies.
-.\"
-.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.\"
-.Dd $Mdocdate: July 9 2023 $
-.Dt ASN1_BUF_PRINT 3
-.Os
-.Sh NAME
-.Nm ASN1_buf_print
-.Nd pretty-print a byte array
-.Sh SYNOPSIS
-.In openssl/asn1.h
-.Ft int
-.Fo ASN1_buf_print
-.Fa "BIO *bio_out"
-.Fa "const unsigned char *buf"
-.Fa "size_t buflen"
-.Fa "int indent"
-.Fc
-.Sh DESCRIPTION
-.Fn ASN1_buf_print
-prints a hexadecimal representation of the first
-.Fa buflen
-bytes from
-.Fa buf
-to
-.Fa bio_out .
-Despite its name and the header file,
-this function has nothing to do with ASN.1.
-.Pp
-Each byte from
-.Fa buf
-is represented by two lower-case hexadecimal digits.
-Fifteen pairs of digits are printed per output line,
-or at most fifteen on the last output line.
-Every output line including the last one ends with a newline character.
-Every pair except the last is followed by a colon
-.Pq Sq \&: .
-If
-.Fa indent
-is greater than zero,
-every output line is indented by
-.Fa indent
-space characters, but not by more than 64 characters.
-.Sh RETURN VALUES
-.Fn ASN1_buf_print
-returns 1 if successful or 0 if printing fails.
-.Sh SEE ALSO
-.Xr ASN1_item_print 3 ,
-.Xr ASN1_STRING_print_ex 3 ,
-.Xr ASN1_TIME_print 3 ,
-.Xr BIO_new 3 ,
-.Xr BIO_write 3
-.Sh HISTORY
-.Fn ASN1_buf_print
-first appeared in OpenSSL 1.1.0 and has been available since
-.Ox 7.3 .
diff --git a/src/lib/libcrypto/man/BIO_new.3 b/src/lib/libcrypto/man/BIO_new.3
index f958149973..bce804131e 100644
--- a/src/lib/libcrypto/man/BIO_new.3
+++ b/src/lib/libcrypto/man/BIO_new.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BIO_new.3,v 1.26 2022/12/23 15:59:34 schwarze Exp $
+.\" $OpenBSD: BIO_new.3,v 1.27 2023/07/21 04:50:47 tb Exp $
 .\" full merge up to:
 .\" OpenSSL man3/BIO_new.pod fb46be03 Feb 26 11:51:31 2016 +0000
 .\" OpenSSL man7/bio.pod 631c37be Dec 12 16:56:50 2017 +0100
@@ -52,7 +52,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: December 23 2022 $
+.Dd $Mdocdate: July 21 2023 $
 .Dt BIO_NEW 3
 .Os
 .Sh NAME
@@ -228,7 +228,6 @@ Create a memory BIO:
 .Pp
 .Dl BIO *mem = BIO_new(BIO_s_mem());
 .Sh SEE ALSO
-.Xr ASN1_buf_print 3 ,
 .Xr BIO_accept 3 ,
 .Xr BIO_ctrl 3 ,
 .Xr BIO_dump 3 ,
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile
index adc54769f5..1039aa0bf0 100644
--- a/src/lib/libcrypto/man/Makefile
+++ b/src/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.254 2023/07/20 16:26:40 tb Exp $
+# $OpenBSD: Makefile,v 1.255 2023/07/21 04:50:47 tb Exp $
 .include <bsd.own.mk>
@@ -18,7 +18,6 @@ MAN=	\
        ASN1_TIME_set.3 \
        ASN1_TYPE_get.3 \
        ASN1_UNIVERSALSTRING_to_string.3 \
-        ASN1_buf_print.3 \
        ASN1_generate_nconf.3 \
        ASN1_get_object.3 \
        ASN1_item_d2i.3 \
author	tb <>	2023-07-21 04:50:47 +0000
committer	tb <>	2023-07-21 04:50:47 +0000
commit	c8e14d21085a5664fe144bcce79739faa47cd45b (patch)
tree	0fdaa156ccc7316bb322a7b0aff921dae6eee27b /src/lib
parent	1c53257d4d340391ea806d02ce30e0f61c72d1b7 (diff)
download	openbsd-c8e14d21085a5664fe144bcce79739faa47cd45b.tar.gz openbsd-c8e14d21085a5664fe144bcce79739faa47cd45b.tar.bz2 openbsd-c8e14d21085a5664fe144bcce79739faa47cd45b.zip

diff --git a/src/lib/libcrypto/man/ASN1_buf_print.3 b/src/lib/libcrypto/man/ASN1_buf_print.3 deleted file mode 100644 index 67b39bea70..0000000000 --- a/src/lib/libcrypto/man/ASN1_buf_print.3 +++ /dev/null
@@ -1,69 +0,0 @@
1	.\" $OpenBSD: ASN1_buf_print.3,v 1.2 2023/07/09 06:45:03 tb Exp $
2	.\"
3	.\" Copyright (c) 2022 Ingo Schwarze <schwarze@openbsd.org>
4	.\"
5	.\" Permission to use, copy, modify, and distribute this software for any
6	.\" purpose with or without fee is hereby granted, provided that the above
7	.\" copyright notice and this permission notice appear in all copies.
8	.\"
9	.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10	.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11	.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12	.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13	.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14	.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15	.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16	.\"
17	.Dd $Mdocdate: July 9 2023 $
18	.Dt ASN1_BUF_PRINT 3
19	.Os
20	.Sh NAME
21	.Nm ASN1_buf_print
22	.Nd pretty-print a byte array
23	.Sh SYNOPSIS
24	.In openssl/asn1.h
25	.Ft int
26	.Fo ASN1_buf_print
27	.Fa "BIO *bio_out"
28	.Fa "const unsigned char *buf"
29	.Fa "size_t buflen"
30	.Fa "int indent"
31	.Fc
32	.Sh DESCRIPTION
33	.Fn ASN1_buf_print
34	prints a hexadecimal representation of the first
35	.Fa buflen
36	bytes from
37	.Fa buf
38	to
39	.Fa bio_out .
40	Despite its name and the header file,
41	this function has nothing to do with ASN.1.
42	.Pp
43	Each byte from
44	.Fa buf
45	is represented by two lower-case hexadecimal digits.
46	Fifteen pairs of digits are printed per output line,
47	or at most fifteen on the last output line.
48	Every output line including the last one ends with a newline character.
49	Every pair except the last is followed by a colon
50	.Pq Sq \&: .
51	If
52	.Fa indent
53	is greater than zero,
54	every output line is indented by
55	.Fa indent
56	space characters, but not by more than 64 characters.
57	.Sh RETURN VALUES
58	.Fn ASN1_buf_print
59	returns 1 if successful or 0 if printing fails.
60	.Sh SEE ALSO
61	.Xr ASN1_item_print 3 ,
62	.Xr ASN1_STRING_print_ex 3 ,
63	.Xr ASN1_TIME_print 3 ,
64	.Xr BIO_new 3 ,
65	.Xr BIO_write 3
66	.Sh HISTORY
67	.Fn ASN1_buf_print
68	first appeared in OpenSSL 1.1.0 and has been available since
69	.Ox 7.3 .


diff --git a/src/lib/libcrypto/man/BIO_new.3 b/src/lib/libcrypto/man/BIO_new.3 index f958149973..bce804131e 100644 --- a/src/lib/libcrypto/man/BIO_new.3 +++ b/src/lib/libcrypto/man/BIO_new.3
@@ -1,4 +1,4 @@
1	.\" $OpenBSD: BIO_new.3,v 1.26 2022/12/23 15:59:34 schwarze Exp $	1	.\" $OpenBSD: BIO_new.3,v 1.27 2023/07/21 04:50:47 tb Exp $
2	.\" full merge up to:	2	.\" full merge up to:
3	.\" OpenSSL man3/BIO_new.pod fb46be03 Feb 26 11:51:31 2016 +0000	3	.\" OpenSSL man3/BIO_new.pod fb46be03 Feb 26 11:51:31 2016 +0000
4	.\" OpenSSL man7/bio.pod 631c37be Dec 12 16:56:50 2017 +0100	4	.\" OpenSSL man7/bio.pod 631c37be Dec 12 16:56:50 2017 +0100
@@ -52,7 +52,7 @@
52	.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED	52	.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
53	.\" OF THE POSSIBILITY OF SUCH DAMAGE.	53	.\" OF THE POSSIBILITY OF SUCH DAMAGE.
54	.\"	54	.\"
55	.Dd $Mdocdate: December 23 2022 $	55	.Dd $Mdocdate: July 21 2023 $
56	.Dt BIO_NEW 3	56	.Dt BIO_NEW 3
57	.Os	57	.Os
58	.Sh NAME	58	.Sh NAME
@@ -228,7 +228,6 @@ Create a memory BIO:
228	.Pp	228	.Pp
229	.Dl BIO *mem = BIO_new(BIO_s_mem());	229	.Dl BIO *mem = BIO_new(BIO_s_mem());
230	.Sh SEE ALSO	230	.Sh SEE ALSO
231	.Xr ASN1_buf_print 3 ,
232	.Xr BIO_accept 3 ,	231	.Xr BIO_accept 3 ,
233	.Xr BIO_ctrl 3 ,	232	.Xr BIO_ctrl 3 ,
234	.Xr BIO_dump 3 ,	233	.Xr BIO_dump 3 ,


diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile index adc54769f5..1039aa0bf0 100644 --- a/src/lib/libcrypto/man/Makefile +++ b/src/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
1	# $OpenBSD: Makefile,v 1.254 2023/07/20 16:26:40 tb Exp $	1	# $OpenBSD: Makefile,v 1.255 2023/07/21 04:50:47 tb Exp $
2		2
3	.include <bsd.own.mk>	3	.include <bsd.own.mk>
4		4
@@ -18,7 +18,6 @@ MAN= \
18	ASN1_TIME_set.3 \	18	ASN1_TIME_set.3 \
19	ASN1_TYPE_get.3 \	19	ASN1_TYPE_get.3 \
20	ASN1_UNIVERSALSTRING_to_string.3 \	20	ASN1_UNIVERSALSTRING_to_string.3 \
21	ASN1_buf_print.3 \
22	ASN1_generate_nconf.3 \	21	ASN1_generate_nconf.3 \
23	ASN1_get_object.3 \	22	ASN1_get_object.3 \
24	ASN1_item_d2i.3 \	23	ASN1_item_d2i.3 \