diff options
| author | Michael Brown | 2007-05-01 02:04:21 +0200 |
|---|---|---|
| committer | Michael Brown | 2007-05-01 02:04:21 +0200 |
| commit | 7ff81f6654b36b12820e76c8fb864afb5b0343bb (patch) | |
| tree | 0e4d3f4848c7b313536db3b8480cb3fdddbd5632 /src/include | |
| parent | D'oh (diff) | |
| download | ipxe-7ff81f6654b36b12820e76c8fb864afb5b0343bb.tar.gz ipxe-7ff81f6654b36b12820e76c8fb864afb5b0343bb.tar.xz ipxe-7ff81f6654b36b12820e76c8fb864afb5b0343bb.zip | |
Document the fact that a zeroed-out refcounted object will behave in
the most generally useful way.
Diffstat (limited to 'src/include')
| -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 |