From 4bf94cc1f736deed7f10c72724313d19b2f1263f Mon Sep 17 00:00:00 2001 From: Giorgos Keramidas Date: Tue, 12 Oct 2004 14:52:52 +0000 Subject: [PATCH] Correctly document the return value of strerror() and strerror_r() and the contents of the returned buffer for unknown error codes. PR: docs/72578 Submitted by: Jilles Tjoelker MFC after: 3 days --- lib/libc/string/strerror.3 | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/lib/libc/string/strerror.3 b/lib/libc/string/strerror.3 index c8c9a20ff35..9f486ed25b5 100644 --- a/lib/libc/string/strerror.3 +++ b/lib/libc/string/strerror.3 @@ -36,7 +36,7 @@ .\" @(#)strerror.3 8.1 (Berkeley) 6/9/93 .\" $FreeBSD$ .\" -.Dd December 19, 2002 +.Dd October 12, 2004 .Dt STRERROR 3 .Os .Sh NAME @@ -102,18 +102,17 @@ a colon and space .Pq Dq Li ":\ " ; otherwise, only the error message string is printed. .Pp -If -.Fa errnum -is not a recognized error number, -.Fn strerror -returns an error message string containing +If the error number is not recognized, these functions return an error message +string containing .Dq Li "Unknown error:\ " -followed by the error number in decimal, while +followed by the error number in decimal. +The +.Fn strerror +and .Fn strerror_r -leaves -.Fa strerrbuf -unchanged and returns -.Er EINVAL . +functions return +.Er EINVAL +as a warning. Error numbers recognized by this implementation fall in the range 0 < .Fa errnum