summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTheo Buehler <tb@cvs.openbsd.org>2024-08-29 20:23:22 +0000
committerTheo Buehler <tb@cvs.openbsd.org>2024-08-29 20:23:22 +0000
commit5d52335c7ca5d8322077fd6641da95be6dd2464b (patch)
tree8dc396c3b5d10d0fae924be065a2782122f50ad2
parent2b32adbe86854b12fd887787ac2f779c24ba173a (diff)
Remove documentation of ERR_add_error_{,v}data()
-rw-r--r--lib/libcrypto/man/ERR_asprintf_error_data.38
-rw-r--r--lib/libcrypto/man/ERR_put_error.341
2 files changed, 8 insertions, 41 deletions
diff --git a/lib/libcrypto/man/ERR_asprintf_error_data.3 b/lib/libcrypto/man/ERR_asprintf_error_data.3
index 67999e9cb08..4291dea23eb 100644
--- a/lib/libcrypto/man/ERR_asprintf_error_data.3
+++ b/lib/libcrypto/man/ERR_asprintf_error_data.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ERR_asprintf_error_data.3,v 1.2 2017/02/21 07:15:21 jmc Exp $
+.\" $OpenBSD: ERR_asprintf_error_data.3,v 1.3 2024/08/29 20:23:21 tb Exp $
.\"
.\" Copyright (c) 2017 Bob Beck <beck@openbsd.org>
.\"
@@ -13,7 +13,7 @@
.\" 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: February 21 2017 $
+.Dd $Mdocdate: August 29 2024 $
.Dt ERR_ASPRINTF_ERROR_DATA 3
.Os
.Sh NAME
@@ -41,9 +41,9 @@ fails, the string "malloc failed" is associated instead.
.Pp
.Nm
is intended to be used instead of the OpenSSL functions
-.Xr ERR_add_error_data 3
+.Fn ERR_add_error_data
and
-.Xr ERR_add_error_vdata 3 .
+.Fn ERR_add_error_vdata .
.Sh SEE ALSO
.Xr ERR 3 ,
.Xr ERR_put_error 3 ,
diff --git a/lib/libcrypto/man/ERR_put_error.3 b/lib/libcrypto/man/ERR_put_error.3
index 7eac5e415c7..37e1b4d1abc 100644
--- a/lib/libcrypto/man/ERR_put_error.3
+++ b/lib/libcrypto/man/ERR_put_error.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ERR_put_error.3,v 1.10 2022/03/31 17:27:16 naddy Exp $
+.\" $OpenBSD: ERR_put_error.3,v 1.11 2024/08/29 20:23:21 tb Exp $
.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
.\"
.\" This file was written by Ulf Moeller <ulf@openssl.org>.
@@ -48,13 +48,11 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: March 31 2022 $
+.Dd $Mdocdate: August 29 2024 $
.Dt ERR_PUT_ERROR 3
.Os
.Sh NAME
-.Nm ERR_put_error ,
-.Nm ERR_add_error_data ,
-.Nm ERR_add_error_vdata
+.Nm ERR_put_error
.Nd record an OpenSSL error
.Sh SYNOPSIS
.In openssl/err.h
@@ -66,16 +64,6 @@
.Fa "const char *file"
.Fa "int line"
.Fc
-.Ft void
-.Fo ERR_add_error_data
-.Fa "int num"
-.Fa ...
-.Fc
-.Ft void
-.Fo ERR_add_error_vdata
-.Fa "int num"
-.Fa "va_list arg"
-.Fc
.Sh DESCRIPTION
.Fn ERR_put_error
adds an error code to the thread's error queue.
@@ -91,20 +79,6 @@ of
.Fa file .
This function is usually called by a macro.
.Pp
-.Fn ERR_add_error_data
-associates the concatenation of its
-.Fa num
-string arguments with the error code added last.
-.Fn ERR_add_error_vdata
-is similar except the argument is a
-.Vt va_list .
-Use of
-.Fn ERR_add_error_data
-and
-.Fn ERR_add_error_vdata
-is deprecated inside of LibreSSL in favour of
-.Xr ERR_asprintf_error_data 3 .
-.Pp
.Xr ERR_load_strings 3
can be used to register error strings so that the application can
generate human-readable error messages for the error code.
@@ -147,12 +121,5 @@ macro.
.Xr ERR_load_strings 3
.Sh HISTORY
.Fn ERR_put_error
-first appeared in SSLeay 0.4.4.
-.Fn ERR_add_error_data
-first appeared in SSLeay 0.9.0.
-Both functions have been available since
+first appeared in SSLeay 0.4.4 and has been available since
.Ox 2.4 .
-.Pp
-.Fn ERR_add_error_vdata
-first appeared in OpenSSL 1.0.1 and has been available since
-.Ox 5.3 .