summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/BIO_dump.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/BIO_dump.3')
-rw-r--r--src/lib/libcrypto/man/BIO_dump.333
1 files changed, 7 insertions, 26 deletions
diff --git a/src/lib/libcrypto/man/BIO_dump.3 b/src/lib/libcrypto/man/BIO_dump.3
index 88ae7d571d..1b66d95679 100644
--- a/src/lib/libcrypto/man/BIO_dump.3
+++ b/src/lib/libcrypto/man/BIO_dump.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: BIO_dump.3,v 1.1 2021/07/10 15:56:18 schwarze Exp $ 1.\" $OpenBSD: BIO_dump.3,v 1.2 2021/07/11 20:18:07 beck Exp $
2.\" 2.\"
3.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> 3.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
4.\" 4.\"
@@ -14,7 +14,7 @@
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\" 16.\"
17.Dd $Mdocdate: July 10 2021 $ 17.Dd $Mdocdate: July 11 2021 $
18.Dt BIO_DUMP 3 18.Dt BIO_DUMP 3
19.Os 19.Os
20.Sh NAME 20.Sh NAME
@@ -98,24 +98,13 @@ are similar except that
98is used instead of 98is used instead of
99.Xr BIO_write 3 . 99.Xr BIO_write 3 .
100.Sh RETURN VALUES 100.Sh RETURN VALUES
101These functions return the sum of the return values of all calls to 101On success these functions return the total number of bytes written by
102.Xr BIO_write 3 102.Xr BIO_write 3
103or 103or
104.Xr fwrite 3 104.Xr fwrite 3 .
105that were made. 105If a failure occurs at any point when writing, these
106This is useless because it may add a positive number, the total amount 106functions will stop after having potentially written out partial results,
107of bytes written by successful calls to 107and return -1.
108.Xr BIO_write 3 ,
109to an incommensurable negative number, usually the number of calls to
110.Xr BIO_write 3
111that failed.
112All that can be said is that a negative return value indicates that
113at least part of the printing failed, and a positive return value
114indicates that at least some of the printing succeeded, but one
115cannot tell whether success or failure were partial or complete.
116Furthermore, a zero return value does not necessarily mean that
117nothing was printed; it can also occur if a part of the printing
118succeeded and another part failed.
119.Sh SEE ALSO 108.Sh SEE ALSO
120.Xr hexdump 1 , 109.Xr hexdump 1 ,
121.Xr BIO_new 3 , 110.Xr BIO_new 3 ,
@@ -134,11 +123,3 @@ and
134.Fn BIO_dump_indent_fp 123.Fn BIO_dump_indent_fp
135first appeared in OpenSSL 0.9.8 and have been available since 124first appeared in OpenSSL 0.9.8 and have been available since
136.Ox 4.5 . 125.Ox 4.5 .
137.Sh BUGS
138If some parts of the printing operations succeed
139and some other parts fail,
140.Fn BIO_dump
141may silently yield incomplete results
142such that the caller cannot detect the partial failure.
143Besides, the function may have written more bytes than the return
144value indicates.