svn commit: r348072 - head/lib/libmd

[Allan Jude]

Author: allanjude
Date: Tue May 21 22:11:53 2019
New Revision: 348072
URL: https://svnweb.freebsd.org/changeset/base/348072

Log:
  Add missing errors section to md[2-5], ripemd160, sha*, and skein* manpages
  
  PR:		148987
  Submitted by:	Dan Lukes <dan at obluda.cz> (original version)
  MFC after:	1 week
  Sponsored by:	Klara Systems
  Event:	Waterloo Hackathon 2019

Modified:
  head/lib/libmd/mdX.3
  head/lib/libmd/ripemd.3
  head/lib/libmd/sha.3
  head/lib/libmd/sha256.3
  head/lib/libmd/sha512.3
  head/lib/libmd/skein.3

Modified: head/lib/libmd/mdX.3
==============================================================================
--- head/lib/libmd/mdX.3	Tue May 21 21:39:03 2019	(r348071)
+++ head/lib/libmd/mdX.3	Tue May 21 22:11:53 2019	(r348072)
@@ -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 ,

Modified: head/lib/libmd/ripemd.3
==============================================================================
--- head/lib/libmd/ripemd.3	Tue May 21 21:39:03 2019	(r348071)
+++ head/lib/libmd/ripemd.3	Tue May 21 22:11:53 2019	(r348072)
@@ -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 ,

Modified: head/lib/libmd/sha.3
==============================================================================
--- head/lib/libmd/sha.3	Tue May 21 21:39:03 2019	(r348071)
+++ head/lib/libmd/sha.3	Tue May 21 22:11:53 2019	(r348072)
@@ -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 ,

Modified: head/lib/libmd/sha256.3
==============================================================================
--- head/lib/libmd/sha256.3	Tue May 21 21:39:03 2019	(r348071)
+++ head/lib/libmd/sha256.3	Tue May 21 22:11:53 2019	(r348072)
@@ -146,6 +146,26 @@ argument is non-null it must point to at least 65 char
 .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 ,

Modified: head/lib/libmd/sha512.3
==============================================================================
--- head/lib/libmd/sha512.3	Tue May 21 21:39:03 2019	(r348071)
+++ head/lib/libmd/sha512.3	Tue May 21 22:11:53 2019	(r348072)
@@ -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 ,

Modified: head/lib/libmd/skein.3
==============================================================================
--- head/lib/libmd/skein.3	Tue May 21 21:39:03 2019	(r348071)
+++ head/lib/libmd/skein.3	Tue May 21 22:11:53 2019	(r348072)
@@ -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 ,