From e98266b1483e9fb2683bbd26e3e8d48dd1f58cec Mon Sep 17 00:00:00 2001
From: Bert Münnich <ber.t@posteo.de>
Date: Wed, 17 May 2017 15:51:11 +0200
Subject: State the purpose of CLEANUP macro

---
 types.h | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'types.h')

diff --git a/types.h b/types.h
index 47d115c..6c87105 100644
--- a/types.h
+++ b/types.h
@@ -21,6 +21,10 @@
 
 #include <stdbool.h>
 
+/*
+ * Annotation for functions called in cleanup().
+ * These functions are not allowed to call error(!0, ...) or exit().
+ */
 #define CLEANUP
 
 typedef enum {
-- 
cgit v1.2.3