Document the fact that a zeroed-out refcounted object will behave in

the most generally useful way.
2007-05-01 00:04:21 +00:00 · 2007-05-01 00:04:21 +00:00 · 7ff81f6654
parent 31f1bf4426
commit 7ff81f6654
1 changed files with 5 additions and 0 deletions
--- a/src/include/gpxe/refcnt.h
+++ b/src/include/gpxe/refcnt.h
@ -12,6 +12,11 @@
 *
 * This data structure is designed to be embedded within a
 * reference-counted object.
+ *
+ * Reference-counted objects are freed when their reference count
+ * drops below zero.  This means that a freshly allocated-and-zeroed
+ * reference-counted object will be freed on the first call to
+ * ref_put().
 */
 struct refcnt {
 	/** Current reference count