summaryrefslogtreecommitdiff
path: root/include/asterisk.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/asterisk.h')
-rw-r--r--include/asterisk.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/asterisk.h b/include/asterisk.h
index edb100b6b..9a0264e8c 100644
--- a/include/asterisk.h
+++ b/include/asterisk.h
@@ -86,6 +86,11 @@ int ast_pbx_init(void); /*!< Provided by pbx.c */
*
* \retval 0 on success.
* \retval -1 on error.
+ *
+ * \note This function should be rarely used in situations where
+ * something must be shutdown to avoid corruption, excessive data
+ * loss, or when external programs must be stopped. All other
+ * cleanup in the core should use ast_register_cleanup.
*/
int ast_register_atexit(void (*func)(void));