diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/include/gpxe/refcnt.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/include/gpxe/refcnt.h b/src/include/gpxe/refcnt.h index ed147b9ac..0930a5777 100644 --- 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 |