From c7f309116d8fa62f6b9fd6ff2902e8ce4bfa192d Mon Sep 17 00:00:00 2001 From: Niels de Vos Date: Fri, 19 Jun 2015 11:36:25 +0200 Subject: refcount: correct the documentation The only check that _gf_ref_get() needs is "== 0" for detecting a failure. The actual return value is not guaranteed to be the number of active refences (they can change in other threads anyway). BUG: 1163543 Change-Id: I8801601eab37046f5a5ee0bce5a62606115ca151 Signed-off-by: Niels de Vos Reviewed-on: http://review.gluster.org/11328 Tested-by: NetBSD Build System Tested-by: Gluster Build System Reviewed-by: Kaleb KEITHLEY --- libglusterfs/src/refcount.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/libglusterfs/src/refcount.h b/libglusterfs/src/refcount.h index 19fa77de9aa..e850e6389ae 100644 --- a/libglusterfs/src/refcount.h +++ b/libglusterfs/src/refcount.h @@ -38,17 +38,17 @@ struct _gf_ref_t { typedef struct _gf_ref_t gf_ref_t; -/* _gf_ref_get -- increase the refcount and return the number of references +/* _gf_ref_get -- increase the refcount * * @return: greater then 0 when a reference was taken, 0 when not */ unsigned int _gf_ref_get (gf_ref_t *ref); -/* _gf_ref_put -- decrease the refcount and return the number of references +/* _gf_ref_put -- decrease the refcount * * @return: greater then 0 when there are still references, 0 when cleanup - * should be done + * should be done, gf_ref_release_t is called on cleanup */ unsigned int _gf_ref_put (gf_ref_t *ref); @@ -95,7 +95,7 @@ _gf_ref_init (gf_ref_t *ref, gf_ref_release_t release, void *data); /* GF_REF_PUT -- decrease the refcount of a GF_REF_DECL structure * * @return: greater then 0 when there are still references, 0 when cleanup - * should be done + * should be done, gf_ref_release_t is called on cleanup */ #define GF_REF_PUT(p) _gf_ref_put (&p->_ref) -- cgit