From: Michael Haggerty <mhagger@alum.mit.edu>
Date: Fri, 12 Aug 2011 21:43:05 +0000 (+0200)
Subject: Document struct match_attr
X-Git-Tag: v1.7.7-rc1~40^2~5
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=ba845b755078a043312119609c1ddd7406b20979;p=git.git

Document struct match_attr

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/attr.c b/attr.c
index 6bc7ae919..c33e4135c 100644
--- a/attr.c
+++ b/attr.c
@@ -113,6 +113,20 @@ struct attr_state {
 	const char *setto;
 };
 
+/*
+ * One rule, as from a .gitattributes file.
+ *
+ * If is_macro is true, then u.attr is a pointer to the git_attr being
+ * defined.
+ *
+ * If is_macro is false, then u.pattern points at the filename pattern
+ * to which the rule applies.  (The memory pointed to is part of the
+ * memory block allocated for the match_attr instance.)
+ *
+ * In either case, num_attr is the number of attributes affected by
+ * this rule, and state is an array listing them.  The attributes are
+ * listed as they appear in the file (macros unexpanded).
+ */
 struct match_attr {
 	union {
 		char *pattern;