From: Bruno Haible <bruno@clisp.org>
Date: Thu, 5 Oct 2023 20:39:52 +0000 (+0200)
Subject: doc: Mention xstrerror.
X-Git-Tag: v1.0~730
X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=be250a8b6af118bcaef40282d69f428158ca9d43;p=gnulib.git

doc: Mention xstrerror.

* doc/posix-functions/strerror_r.texi: Mention xstrerror.
---

diff --git a/ChangeLog b/ChangeLog
index 6df9aaaef7..1a0dcd1597 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2023-10-05  Bruno Haible  <bruno@clisp.org>
 
+	doc: Mention xstrerror.
+	* doc/posix-functions/strerror_r.texi: Mention xstrerror.
+
 	xstrerror: Add tests.
 	* tests/test-xstrerror.c: New file.
 	* modules/xstrerror-tests: New file.
diff --git a/doc/posix-functions/strerror_r.texi b/doc/posix-functions/strerror_r.texi
index d0b35a6ba9..2e622cd8d7 100644
--- a/doc/posix-functions/strerror_r.texi
+++ b/doc/posix-functions/strerror_r.texi
@@ -86,3 +86,8 @@ OpenBSD 4.7.
 Portability problems not fixed by Gnulib:
 @itemize
 @end itemize
+
+Note: Gnulib has a module @code{xstrerror}, with the property that
+@code{xstrerror (NULL, errnum)} returns the value of @code{strerror_r}
+as a freshly allocated string.
+(Recall that the expression @code{strerror (errnum)} is not multithread-safe.)