Browse Source

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

the most generally useful way.
tags/v0.9.3
Michael Brown 17 years ago
parent
commit
7ff81f6654
1 changed files with 5 additions and 0 deletions
  1. 5
    0
      src/include/gpxe/refcnt.h

+ 5
- 0
src/include/gpxe/refcnt.h View File

@@ -12,6 +12,11 @@
12 12
  *
13 13
  * This data structure is designed to be embedded within a
14 14
  * reference-counted object.
15
+ *
16
+ * Reference-counted objects are freed when their reference count
17
+ * drops below zero.  This means that a freshly allocated-and-zeroed
18
+ * reference-counted object will be freed on the first call to
19
+ * ref_put().
15 20
  */
16 21
 struct refcnt {
17 22
 	/** Current reference count

Loading…
Cancel
Save