Rework library error reporting.

[cdecl99.git] / doc / libcdecl.3

diff --git a/doc/libcdecl.3 b/doc/libcdecl.3
index 495a353f68b8810ee27b59f6876cc64abc86eb40..dd70f496e0bf3dd619c6b5ee21ab77cf9e6ce1ff 100644 (file)
--- a/doc/libcdecl.3
+++ b/doc/libcdecl.3
@@ -1,4 +1,4 @@
-.Dd March 6, 2021
+.Dd March 13, 2021
 .Os cdecl99
 .Dt LIBCDECL \&3 "Cdecl99 Developer's Manual"
 .Sh NAME
@@ -322,20 +322,21 @@ This error information can be retrieved by calling the function
 .Pp
 which returns a pointer to the error structure most recently generated in the
 current thread.
-It is therefore thread-safe in that errors occurring in another thread will not
-interfere with the current one.
-The returned pointer shall remain valid until the next call to any function
+It is therefore thread-safe in the sense that errors occurring concurrently
+in another thread will not interfere with a call to
+.Fn cdecl_get_error .
+The returned structure shall remain valid until the next call to any function
 from
-.Nm
-by the same thread, except that multiple consecutive calls to
-.Va cdecl_get_error
-shall all return the same value.
-The same applies to the
-.Va str
-pointer inside the error structure itself.
+.Nm ,
+by the same thread, other than another call to
+.Fn cdecl_get_error .
 .Pp
-If this function is called before an error has been indicated by an earlier
-call in the same thread, the behaviour is undefined.
+If no prior
+.Nm
+call has indicated that an error occurred in the current thread, the result
+from calling
+.Fn cdecl_get_error
+is unspecified.
 .Sh PARSING DECLARATIONS
 To parse a declaration, the function
 .Pp