From: Willem Toorop <willem@NLnetLabs.nl>
Date: Wed, 18 May 2011 14:43:58 +0000 (+0000)
Subject: code review #7: Fix comment for is_glue in ldns_dnssec_name struct.
X-Git-Tag: release-1.6.10rc1~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2f4e938efa79e6be6e339aa789560aa8e4e1f701;p=thirdparty%2Fldns.git

code review #7: Fix comment for is_glue in ldns_dnssec_name struct.
---

diff --git a/ldns/dnssec_zone.h b/ldns/dnssec_zone.h
index 7751b419..4b0273eb 100644
--- a/ldns/dnssec_zone.h
+++ b/ldns/dnssec_zone.h
@@ -70,14 +70,13 @@ struct ldns_struct_dnssec_name
 	 */
 	ldns_dnssec_rrs *nsec_signatures;
 	/**
-	 * Set to true if this name contains only glue rrsets.
-	 * Names that contain other obscured rrsets and records with glue on the
-	 * delegation point will NOT have this bool set to true.
-	 * ldns_dnssec_zone_mark_glue() should have been called before using this
-	 * field.
-	 * This field should not be read directly, but only via the 
-	 * ldns_dnssec_name_is_glue() function.
-	 * 
+	 * Unlike what the name is_glue suggests, this field is set to true by
+	 * ldns_dnssec_zone_mark_glue() or ldns_dnssec_zone_mark_and_get_glue()
+	 * when the name, this dnssec_name struct represents, is occluded.
+	 * Names that contain other obscured rrsets and records with glue on
+	 * the delegation point will NOT have this bool set to true.
+	 * This field should NOT be read directly, but only via the 
+	 * ldns_dnssec_name_is_glue() function!
 	 */
 	bool is_glue;
 	/**