X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib/blobdiff_plain/3618811496a6d131fd4bffa19e262c521d39e819..db0e70a131f1a3a28cc78cface5b5db87b0d5416:/utils/macros.3

diff --git a/utils/macros.3 b/utils/macros.3
index 2d17fa6..d481a47 100644
--- a/utils/macros.3
+++ b/utils/macros.3
@@ -30,6 +30,7 @@ macros \- useful macros
 .\" @DEPRECATED
 .\" @EXECL_LIKE
 .\" @IGNORABLE
+.\" @MUST_CHECK
 .\" @NORETURN
 .\" @PRINTF_LIKE
 .\" @SCANF_LIKE
@@ -37,6 +38,7 @@ macros \- useful macros
 .\" @MUFFLE_WARNINGS_EXPR
 .\" @MUFFLE_WARNINGS_STMT
 .\" @GCC_WARNING
+.\" @CLANG_WARNING
 .SH SYNOPSIS
 .nf
 .B "#include <mLib/macros.h>"
@@ -73,6 +75,7 @@ macros \- useful macros
 .BI "DEPRECATED(" msg ")"
 .BI "EXECL_LIKE(" ntrail ")"
 .BI "IGNORABLE"
+.BI "MUST_CHECK"
 .BI "NORETURN"
 .BI "PRINTF_LIKE(" fmt-index ", " arg-index ")"
 .BI "SCANF_LIKE(" fmt-index ", " arg-index ")"
@@ -192,6 +195,12 @@ need not be used.  This may muffle warnings about leaving the marked
 definition unused.
 .PP
 A function marked as
+.B MUST_CHECK
+returns an important value: a warning may be issued if a caller
+ignores the value.  The return type must not be
+.BR void .
+.PP
+A function marked as
 .B NORETURN
 must not return.  It must have return type
 .BR void .