aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaromil <jaromil@dyne.org>2016-06-02 12:15:08 +0200
committerWilliam Hubbs <w.d.hubbs@gmail.com>2016-07-13 17:04:28 -0500
commit7f84b5d741c150cd159d5a3cda3ef532f0381826 (patch)
treebb8bf9e195e47b7cc695b7ffb42c34d5bbbaeed0
parent8bca2cd4b3c710809131ac036456b34c223e8d12 (diff)
libeinfo: document the x suffix on function names
This fixes #88.
-rw-r--r--src/libeinfo/einfo.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/libeinfo/einfo.h b/src/libeinfo/einfo.h
index 58aedd94..83c2a799 100644
--- a/src/libeinfo/einfo.h
+++ b/src/libeinfo/einfo.h
@@ -71,6 +71,7 @@ void elog(int, const char * EINFO_RESTRICT, ...) EINFO_PRINTF(2, 3);
*
* The n suffix denotes that no new line should be printed.
* The v suffix means only print if EINFO_VERBOSE is yes.
+ * The x suffix means function will exit() returning failure.
*/
/*@{*/
int einfon(const char * __EINFO_RESTRICT, ...) EINFO_PRINTF(1, 2);