[src/trunk]: src/lib/libc/string Move the note about sys_errlist[] users to C...

[dholland <dholland%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/18e02f311da5
branches:  trunk
changeset: 1008885:18e02f311da5
user:      dholland <dholland%NetBSD.org@localhost>
date:      Sat Apr 04 21:29:54 2020 +0000

description:
Move the note about sys_errlist[] users to COMPATIBILITY, and strengthen it.

diffstat:

 lib/libc/string/strerror.3 |  14 ++++++++------
 1 files changed, 8 insertions(+), 6 deletions(-)

diffs (32 lines):

diff -r add7dad5230c -r 18e02f311da5 lib/libc/string/strerror.3
--- a/lib/libc/string/strerror.3        Sat Apr 04 21:26:44 2020 +0000
+++ b/lib/libc/string/strerror.3        Sat Apr 04 21:29:54 2020 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: strerror.3,v 1.23 2020/04/04 21:26:44 dholland Exp $
+.\" $NetBSD: strerror.3,v 1.24 2020/04/04 21:29:54 dholland Exp $
 .\"
 .\" Copyright (c) 1980, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -209,6 +209,13 @@
 one of the
 .Fn strerror
 family of functions should be used instead.
+.Sh COMPATIBILITY
+Programs that attempt to use the deprecated
+.Va sys_errlist
+variable often fail to compile because they provide their own,
+inconsistent, declaration of it.
+Such programs should be updated to use
+.Fn strerror .
 .Sh ERRORS
 These functions may fail if:
 .Bl -tag -width Er
@@ -280,8 +287,3 @@
 .Fn strerror_l
 use the same thread local storage; a call to either will destroy
 the result from an earlier call by the same thread of either of them.
-.Pp
-Programs that use the deprecated
-.Va sys_errlist
-variable often fail to compile because they declare it
-inconsistently.