Mark a number of BIO_ctrl(3) command constants as intentionally
authorschwarze <schwarze@openbsd.org>
Fri, 28 Apr 2023 16:49:00 +0000 (16:49 +0000)
committerschwarze <schwarze@openbsd.org>
Fri, 28 Apr 2023 16:49:00 +0000 (16:49 +0000)
undocumented because they are NOOPs or deprecated.

lib/libcrypto/man/BIO_f_buffer.3
lib/libcrypto/man/BIO_f_cipher.3
lib/libcrypto/man/BIO_s_bio.3
lib/libcrypto/man/BIO_s_datagram.3
lib/libcrypto/man/BIO_s_file.3

index 412ec52..45c1b33 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BIO_f_buffer.3,v 1.15 2023/04/26 15:03:02 schwarze Exp $
+.\" $OpenBSD: BIO_f_buffer.3,v 1.16 2023/04/28 16:49:00 schwarze Exp $
 .\" full merge up to OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
 .\"
 .\" This file is a derived work.
@@ -66,7 +66,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: April 26 2023 $
+.Dd $Mdocdate: April 28 2023 $
 .Dt BIO_F_BUFFER 3
 .Os
 .Sh NAME
 .Nm BIO_set_write_buffer_size ,
 .Nm BIO_set_buffer_size ,
 .Nm BIO_set_buffer_read_data
-.\" .Nm BIO_buffer_get_num_lines is intentionally undocumented.
-.\" Contrary to what bio.h says, it does not *not* get some "IO type",
-.\" whatever that is supposed to be, but is a NOOP, and nothing uses it.
+.\" .Nm BIO_buffer_get_num_lines and
+.\" .Nm BIO_CTRL_GET are intentionally undocumented.
+.\" Contrary to what bio.h says, they do not *not* get some "IO type",
+.\" whatever that is supposed to be, but are NOOPs, and nothing uses them.
 .Nd buffering BIO
 .Sh SYNOPSIS
 .In openssl/bio.h
index 56bd27c..de9d884 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BIO_f_cipher.3,v 1.14 2023/04/11 16:58:43 schwarze Exp $
+.\" $OpenBSD: BIO_f_cipher.3,v 1.15 2023/04/28 16:49:00 schwarze Exp $
 .\" full merge up to: OpenSSL e9b77246 Jan 20 19:58:49 2017 +0100
 .\"
 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -49,7 +49,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: April 11 2023 $
+.Dd $Mdocdate: April 28 2023 $
 .Dt BIO_F_CIPHER 3
 .Os
 .Sh NAME
@@ -57,6 +57,7 @@
 .Nm BIO_set_cipher ,
 .Nm BIO_get_cipher_status ,
 .Nm BIO_get_cipher_ctx
+.\" .Nm BIO_CTRL_SET is intentionally undocumented because it has no effect.
 .Nd cipher BIO filter
 .Sh SYNOPSIS
 .In openssl/bio.h
index d009b3d..faa6adf 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BIO_s_bio.3,v 1.17 2023/04/11 16:58:43 schwarze Exp $
+.\" $OpenBSD: BIO_s_bio.3,v 1.18 2023/04/28 16:49:00 schwarze Exp $
 .\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
 .\"
 .\" This file was written by
@@ -53,7 +53,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: April 11 2023 $
+.Dd $Mdocdate: April 28 2023 $
 .Dt BIO_S_BIO 3
 .Os
 .Sh NAME
 .\" .Nm BIO_nread
 .\" .Nm BIO_nwrite0
 .\" .Nm BIO_nwrite
+.\" .Nm BIO_C_NREAD0
+.\" .Nm BIO_C_NREAD
+.\" .Nm BIO_C_NWRITE0
+.\" .Nm BIO_C_NWRITE
 .Nd BIO pair BIO
 .Sh SYNOPSIS
 .In openssl/bio.h
index 5ee6fca..104823e 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BIO_s_datagram.3,v 1.2 2022/12/28 07:59:13 jsg Exp $
+.\" $OpenBSD: BIO_s_datagram.3,v 1.3 2023/04/28 16:49:00 schwarze Exp $
 .\"
 .\" Copyright (c) 2022 Ingo Schwarze <schwarze@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: December 28 2022 $
+.Dd $Mdocdate: April 28 2023 $
 .Dt BIO_S_DATAGRAM 3
 .Os
 .Sh NAME
@@ -27,6 +27,9 @@
 .Nm BIO_dgram_recv_timedout ,
 .Nm BIO_dgram_send_timedout ,
 .Nm BIO_dgram_non_fatal_error
+.\" .Nm BIO_CTRL_DGRAM_QUERY_MTU and
+.\" .Nm BIO_CTRL_DGRAM_MTU_DISCOVER are intentionally undocumented.
+.\" They are almost unused, and OpenBSD does not appear to support them.
 .Nd datagram socket BIO
 .Sh SYNOPSIS
 .In openssl/bio.h
@@ -381,8 +384,6 @@ Control commands correspond to accessor functions as follows:
 .It Dv BIO_CTRL_SET_CLOSE
 .Xr BIO_set_close 3
 .El
-.\" OpenBSD does not appear to support
-.\" BIO_CTRL_DGRAM_MTU_DISCOVER and BIO_CTRL_DGRAM_QUERY_MTU.
 .Ss Input and output operations
 .Xr BIO_read 3
 attempts to read up to
index 884412c..00a30e5 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: BIO_s_file.3,v 1.13 2023/04/26 15:03:02 schwarze Exp $
+.\" $OpenBSD: BIO_s_file.3,v 1.14 2023/04/28 16:49:00 schwarze Exp $
 .\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
 .\" selective merge up to: OpenSSL 1212818e Sep 11 13:22:14 2018 +0100
 .\"
@@ -66,7 +66,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: April 26 2023 $
+.Dd $Mdocdate: April 28 2023 $
 .Dt BIO_S_FILE 3
 .Os
 .Sh NAME
@@ -79,6 +79,7 @@
 .Nm BIO_write_filename ,
 .Nm BIO_append_filename ,
 .Nm BIO_rw_filename
+.\" Nm BIO_CTRL_SET_FILENAME is unsused and intentionally undocumented.
 .Nd FILE BIO
 .Sh SYNOPSIS
 .In openssl/bio.h