docs/148987: [ PATCH ] {MD[245]|SHA_|SHA1_|SHA256_}{End|File|FileChunk} errno's are not documented

[Dan Lukes]

>Number:         148987
>Category:       docs
>Synopsis:       [ PATCH ] {MD[245]|SHA_|SHA1_|SHA256_}{End|File|FileChunk} errno's are not documented
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Jul 27 08:40:01 UTC 2010
>Closed-Date:
>Last-Modified:
>Originator:     Dan Lukes
>Release:        FreeBSD 7.3-RELEASE-p2 i386
>Organization:
Obludarium
>Environment:
System: FreeBSD 7.3-RELEASE-p2 i386
lib/libmd/mdX.3,v 1.30.10.1 2010/02/10 00:26:20 kensmith

>Description:
ERRORS section is not present within manual page for MD[245]End/SHA1_End/SHA256_End function and related *_File/*_FileChunk functions. 
>How-To-Repeat:
>Fix:

ERRORS section should be added.

Attached patch is for MDx suite, but the same section should be added to sha.3/sha256.3 as well

Please rephrase my texts if necesarry.

--- lib/libmd/mdX.3.orig	2010-07-27 09:37:42.000000000 +0200
+++ lib/libmd/mdX.3	2010-07-27 09:57:06.000000000 +0200
@@ -143,6 +143,26 @@
 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 caled with 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
+failed. For the list of possible errno's see documentation of such functions.
 .Sh SEE ALSO
 .Xr md2 3 ,
 .Xr md4 3 ,

>Release-Note:
>Audit-Trail:
>Unformatted: