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

the most generally useful way.

diff --git a/src/include/gpxe/refcnt.h b/src/include/gpxe/refcnt.h
index ed147b9..0930a57 100644 (file)
--- 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.
  *
  * 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
  */
 struct refcnt {
        /** Current reference count