From: Florian Forster <ff@octo.it>
Date: Wed, 23 Jun 2010 07:08:07 +0000 (+0200)
Subject: src/graph_instance.h: Document the behavior of "inst_matches_field".
X-Git-Tag: v4.0.0~198^2~4
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=240d39c9b5fdc60bb8a3d55510fd5974c7c137ec;p=collection4.git

src/graph_instance.h: Document the behavior of "inst_matches_field".
---

diff --git a/src/graph_instance.h b/src/graph_instance.h
index 1baccc6..b1d2df9 100644
--- a/src/graph_instance.h
+++ b/src/graph_instance.h
@@ -34,6 +34,11 @@ _Bool inst_matches_ident (graph_instance_t *inst, const graph_ident_t *ident);
 _Bool inst_matches_string (graph_config_t *cfg, graph_instance_t *inst,
     const char *term);
 
+/* Compares the given string with the appropriate field of the selector or, if
+ * the selector field is "/all/", iterates over all the files of the instance
+ * and checks the appropriate field. Returns true if the field of the selector
+ * or of one of the files matches. The string must match entirely but
+ * comparison is done case-insensitive. */
 _Bool inst_matches_field (graph_instance_t *inst,
     graph_ident_field_t field, const char *field_value);