1
0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-13 10:02:38 +00:00

Add missing errors section to md[2-5], ripemd160, sha*, and skein* manpages

PR:		148987
Submitted by:	Dan Lukes <dan@obluda.cz> (original version)
MFC after:	1 week
Sponsored by:	Klara Systems
Event:	Waterloo Hackathon 2019
This commit is contained in:
Allan Jude 2019-05-21 22:11:53 +00:00
parent 57e9b361ba
commit f26f4cf170
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=348072
6 changed files with 124 additions and 4 deletions

View File

@ -8,7 +8,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd July 20, 2018
.Dd May 21, 2019
.Dt MDX 3
.Os
.Sh NAME
@ -144,6 +144,26 @@ after use.
If the
.Fa buf
argument is non-null it must point to at least 33 characters of buffer space.
.Sh ERRORS
The
.Fn MDXEnd
function called with a null buf argument may fail and return NULL if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient storage space is available.
.El
.Pp
The
.Fn MDXFile
and
.Fn MDXFileChunk
may return NULL when underlying
.Xr open 2 ,
.Xr fstat 2 ,
.Xr lseek 2 ,
or
.Xr MDXEnd 2
fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,

View File

@ -124,6 +124,26 @@ after use.
If the
.Fa buf
argument is non-null it must point to at least 41 characters of buffer space.
.Sh ERRORS
The
.Fn RIPEMD160_End
function called with a null buf argument may fail and return NULL if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient storage space is available.
.El
.Pp
The
.Fn RIPEMD160_File
and
.Fn RIPEMD160_FileChunk
may return NULL when underlying
.Xr open 2 ,
.Xr fstat 2 ,
.Xr lseek 2 ,
or
.Xr RIPEMD160_End 2
fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,

View File

@ -9,7 +9,7 @@
.\" From: Id: mdX.3,v 1.14 1999/02/11 20:31:49 wollman Exp
.\" $FreeBSD$
.\"
.Dd July 20, 2018
.Dd May 21, 2019
.Dt SHA 3
.Os
.Sh NAME
@ -155,6 +155,26 @@ after use.
If the
.Fa buf
argument is non-null it must point to at least 41 characters of buffer space.
.Sh ERRORS
The
.Fn SHA1_End
function called with a null buf argument may fail and return NULL if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient storage space is available.
.El
.Pp
The
.Fn SHA1_File
and
.Fn SHA1_FileChunk
may return NULL when underlying
.Xr open 2 ,
.Xr fstat 2 ,
.Xr lseek 2 ,
or
.Xr SHA1_End 2
fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,

View File

@ -146,6 +146,26 @@ argument is non-null it must point to at least 65 characters of buffer space.
.Pp
SHA224 is identical SHA256, except it has slightly different initialization
vectors, and is truncated to a shorter digest.
.Sh ERRORS
The
.Fn SHA256_End
function called with a null buf argument may fail and return NULL if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient storage space is available.
.El
.Pp
The
.Fn SHA256_File
and
.Fn SHA256_FileChunk
may return NULL when underlying
.Xr open 2 ,
.Xr fstat 2 ,
.Xr lseek 2 ,
or
.Xr SHA256_End 2
fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,

View File

@ -9,7 +9,7 @@
.\" From: Id: mdX.3,v 1.14 1999/02/11 20:31:49 wollman Exp
.\" $FreeBSD$
.\"
.Dd July 20, 2018
.Dd May 21, 2019
.Dt SHA512 3
.Os
.Sh NAME
@ -190,6 +190,26 @@ which converts the return value to a 65-character
(including the terminating '\e0')
.Tn ASCII
string which represents the 256 bits in hexadecimal.
.Sh ERRORS
The
.Fn SHA512_End
function called with a null buf argument may fail and return NULL if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient storage space is available.
.El
.Pp
The
.Fn SHA512_File
and
.Fn SHA512_FileChunk
may return NULL when underlying
.Xr open 2 ,
.Xr fstat 2 ,
.Xr lseek 2 ,
or
.Xr SHA512_End 2
fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,

View File

@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd May 28, 2016
.Dd May 21, 2019
.Dt SKEIN 3
.Os
.Sh NAME
@ -188,6 +188,26 @@ functions are similar to the
.Li SKEIN256_
functions except they produce a 512-bit, 65 character,
or 1024-bit, 129 character, output.
.Sh ERRORS
The
.Fn SKEIN256_End
function called with a null buf argument may fail and return NULL if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient storage space is available.
.El
.Pp
The
.Fn SKEIN256_File
and
.Fn SKEIN256_FileChunk
may return NULL when underlying
.Xr open 2 ,
.Xr fstat 2 ,
.Xr lseek 2 ,
or
.Xr SKEIN256_End 2
fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,