diff options
author | tb <> | 2023-07-26 20:12:45 +0000 |
---|---|---|
committer | tb <> | 2023-07-26 20:12:45 +0000 |
commit | b12033b0f03ee70af46b994b0f8b8ae1e6190ce9 (patch) | |
tree | 707938f08350ad7df91cac17d00b08e7d50a287b | |
parent | fa5c0091f4e78c4c6829aa0fb64a17d34a5d05fd (diff) | |
download | openbsd-b12033b0f03ee70af46b994b0f8b8ae1e6190ce9.tar.gz openbsd-b12033b0f03ee70af46b994b0f8b8ae1e6190ce9.tar.bz2 openbsd-b12033b0f03ee70af46b994b0f8b8ae1e6190ce9.zip |
Remove BUF_reverse and BUF_strdup documentation
-rw-r--r-- | src/lib/libcrypto/man/BUF_MEM_new.3 | 55 |
1 files changed, 2 insertions, 53 deletions
diff --git a/src/lib/libcrypto/man/BUF_MEM_new.3 b/src/lib/libcrypto/man/BUF_MEM_new.3 index 904e6f2a84..d6912c398b 100644 --- a/src/lib/libcrypto/man/BUF_MEM_new.3 +++ b/src/lib/libcrypto/man/BUF_MEM_new.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: BUF_MEM_new.3,v 1.16 2019/06/06 01:06:58 schwarze Exp $ | 1 | .\" $OpenBSD: BUF_MEM_new.3,v 1.17 2023/07/26 20:12:45 tb Exp $ |
2 | .\" OpenSSL doc/crypto/buffer.pod 18edda0f Sep 20 03:28:54 2000 +0000 | 2 | .\" OpenSSL doc/crypto/buffer.pod 18edda0f Sep 20 03:28:54 2000 +0000 |
3 | .\" not merged: 74924dcb, 58e3457a, 21b0fa91, 7644a9ae | 3 | .\" not merged: 74924dcb, 58e3457a, 21b0fa91, 7644a9ae |
4 | .\" OpenSSL doc/crypto/BUF_MEM_new.pod 53934822 Jun 9 16:39:19 2016 -0400 | 4 | .\" OpenSSL doc/crypto/BUF_MEM_new.pod 53934822 Jun 9 16:39:19 2016 -0400 |
@@ -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: June 6 2019 $ | 55 | .Dd $Mdocdate: July 26 2023 $ |
56 | .Dt BUF_MEM_NEW 3 | 56 | .Dt BUF_MEM_NEW 3 |
57 | .Os | 57 | .Os |
58 | .Sh NAME | 58 | .Sh NAME |
@@ -60,8 +60,6 @@ | |||
60 | .Nm BUF_MEM_free , | 60 | .Nm BUF_MEM_free , |
61 | .Nm BUF_MEM_grow , | 61 | .Nm BUF_MEM_grow , |
62 | .Nm BUF_MEM_grow_clean , | 62 | .Nm BUF_MEM_grow_clean , |
63 | .Nm BUF_reverse , | ||
64 | .Nm BUF_strdup | ||
65 | .Nd simple character arrays structure | 63 | .Nd simple character arrays structure |
66 | .Sh SYNOPSIS | 64 | .Sh SYNOPSIS |
67 | .In openssl/buffer.h | 65 | .In openssl/buffer.h |
@@ -83,16 +81,6 @@ | |||
83 | .Fa "BUF_MEM *str" | 81 | .Fa "BUF_MEM *str" |
84 | .Fa "size_t len" | 82 | .Fa "size_t len" |
85 | .Fc | 83 | .Fc |
86 | .Ft void | ||
87 | .Fo BUF_reverse | ||
88 | .Fa "unsigned char *out" | ||
89 | .Fa "const unsigned char *in" | ||
90 | .Fa "size_t len" | ||
91 | .Fc | ||
92 | .Ft char * | ||
93 | .Fo BUF_strdup | ||
94 | .Fa "const char *str" | ||
95 | .Fc | ||
96 | .Sh DESCRIPTION | 84 | .Sh DESCRIPTION |
97 | The buffer library handles simple character arrays. | 85 | The buffer library handles simple character arrays. |
98 | Buffers are used for various purposes in the library, most notably | 86 | Buffers are used for various purposes in the library, most notably |
@@ -138,40 +126,6 @@ Any data already in the buffer is preserved if it increases in size. | |||
138 | is similar to | 126 | is similar to |
139 | .Fn BUF_MEM_grow , | 127 | .Fn BUF_MEM_grow , |
140 | but it sets any freed or additionally allocated memory to zero. | 128 | but it sets any freed or additionally allocated memory to zero. |
141 | .Pp | ||
142 | .Fn BUF_reverse | ||
143 | reverses | ||
144 | .Fa len | ||
145 | bytes at | ||
146 | .Fa in | ||
147 | into | ||
148 | .Fa out . | ||
149 | If | ||
150 | .Fa in | ||
151 | is | ||
152 | .Dv NULL , | ||
153 | .Fa out | ||
154 | is reversed in place. | ||
155 | .Pp | ||
156 | .Fn BUF_strdup | ||
157 | copies a NUL terminated string into a block of allocated memory and | ||
158 | returns a pointer to the allocated block. | ||
159 | Unlike the system | ||
160 | .Xr strdup 3 | ||
161 | function, | ||
162 | .Fn BUF_strdup | ||
163 | will accept a | ||
164 | .Dv NULL | ||
165 | argument and will return | ||
166 | .Dv NULL | ||
167 | in that case. | ||
168 | Its use in new programs is discouraged. | ||
169 | .Pp | ||
170 | The memory allocated from | ||
171 | .Fn BUF_strdup | ||
172 | should be freed up using the | ||
173 | .Xr free 3 | ||
174 | function. | ||
175 | .Sh RETURN VALUES | 129 | .Sh RETURN VALUES |
176 | .Fn BUF_MEM_new | 130 | .Fn BUF_MEM_new |
177 | returns the buffer or | 131 | returns the buffer or |
@@ -192,8 +146,6 @@ return zero on error or the new size (i.e.\& | |||
192 | and | 146 | and |
193 | .Fn BUF_MEM_grow | 147 | .Fn BUF_MEM_grow |
194 | first appeared in SSLeay 0.6.0. | 148 | first appeared in SSLeay 0.6.0. |
195 | .Fn BUF_strdup | ||
196 | first appeared in SSLeay 0.8.0. | ||
197 | All these functions have been available since | 149 | All these functions have been available since |
198 | .Ox 2.4 . | 150 | .Ox 2.4 . |
199 | .Pp | 151 | .Pp |
@@ -201,6 +153,3 @@ All these functions have been available since | |||
201 | first appeared in OpenSSL 0.9.7 and has been available since | 153 | first appeared in OpenSSL 0.9.7 and has been available since |
202 | .Ox 3.2 . | 154 | .Ox 3.2 . |
203 | .Pp | 155 | .Pp |
204 | .Fn BUF_reverse | ||
205 | first appeared in OpenSSL 1.0.0 and has been available since | ||
206 | .Ox 4.9 . | ||