From: Russell Bryant <russell@russellbryant.com>
Date: Wed, 25 Mar 2009 22:11:35 +0000 (+0000)
Subject: Remove unneeded AST_LIST_ENTRY() and comment on the purpose of ast_event_ref.
X-Git-Tag: 11.0.0-beta1~5179
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=189a55f9f0828147aed08ab7ce4af2c4b177a16e;p=thirdparty%2Fasterisk.git

Remove unneeded AST_LIST_ENTRY() and comment on the purpose of ast_event_ref.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@184344 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/main/event.c b/main/event.c
index e29f057e3f..11f022f903 100644
--- a/main/event.c
+++ b/main/event.c
@@ -86,9 +86,18 @@ struct ast_event {
 	unsigned char payload[0];
 } __attribute__((packed));
 
+
+/*!
+ * \brief A holder for an event
+ *
+ * \details This struct used to have more of a purpose than it does now.
+ * It is used to hold events in the event cache.  It can be completely removed
+ * if one of these two things is done:
+ *  - ast_event gets changed such that it never has to be realloc()d
+ *  - astobj2 is updated so that you can realloc() an astobj2 object
+ */
 struct ast_event_ref {
 	struct ast_event *event;
-	AST_LIST_ENTRY(ast_event_ref) entry;
 };
 
 struct ast_event_ie_val {