aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGleb Smirnoff <glebius@FreeBSD.org>2025-09-25 08:19:46 +0000
committerGleb Smirnoff <glebius@FreeBSD.org>2025-09-25 08:19:46 +0000
commitb0091036f7240ab244e86a087b18459185a260de (patch)
treedcdb3e8dabfc3e80d46573eac8b42e64ada68f78
parentb00e65ff70a4613b3bf2fd2781d174fa437fbfbe (diff)
psignal(3): document return values of sig2str() and str2sig
Reviewed by: bcr Differential Revision: https://reviews.freebsd.org/D52698
-rw-r--r--lib/libc/gen/psignal.39
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/libc/gen/psignal.3 b/lib/libc/gen/psignal.3
index 098b7b02a9b9..bf6a99b4b113 100644
--- a/lib/libc/gen/psignal.3
+++ b/lib/libc/gen/psignal.3
@@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd May 10, 2025
+.Dd September 23, 2025
.Dt PSIGNAL 3
.Os
.Sh NAME
@@ -141,6 +141,13 @@ The name in
can be either the name of the signal, with or without the
.Dq SIG
prefix, or a decimal number.
+.Sh RETURN VALUES
+The
+.Fn sig2str
+and
+.Fn str2sig
+return 0 on success and -1 on translation failure.
+In the latter case the memory to store the translation result is left intact.
.Sh SEE ALSO
.Xr sigaction 2 ,
.Xr perror 3 ,