[Levent-commits] [Libevent/master 1/3] Document a change in the semantics of event_get_struct_event_size()

[Nick M. <ni...@us...>]

Author: Nick Mathewson <ni...@to...>
Date: Sat, 19 Jun 2010 18:21:40 -0400
Subject: Document a change in the semantics of event_get_struct_event_size()
Commit: e21f5d15ebcc42a2f3300f59afad0c599a0f41a2

---
 include/event2/event.h |    8 ++++++--
 1 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/include/event2/event.h b/include/event2/event.h
index 01d134e..e048669 100644
--- a/include/event2/event.h
+++ b/include/event2/event.h
@@ -605,9 +605,13 @@ void event_get_assignment(const struct event *event, struct event_base **base_ou
    Return the size of struct event that the Libevent library was compiled
    with.
 
-   This will be the same as sizeof(struct event) if you're running with the
-   same version of Libevent that your application was built with, but
+   This will be NO GREATER than sizeof(struct event) if you're running with
+   the same version of Libevent that your application was built with, but
    otherwise might not.
+
+   Note that it might be SMALLER than sizeof(struct event) if some future
+   version of Libevent adds extra buffer space to the end of struct event
+   to ensure 
  */
 size_t event_get_struct_event_size(void);
 
-- 
1.6.3