nss: improve comments

[nsscash/nsscash.git] / nss / search.h

diff --git a/nss/search.h b/nss/search.h
index 5a1b52e59a524accca32b966d9f421d17ea930f8..f3fbc9a3af13924665791f7ac07014193eff1de2 100644 (file)
--- a/nss/search.h
+++ b/nss/search.h
@@ -24,10 +24,15 @@
 
 
 struct search_key {
-    const char *name;
-    const uint64_t *id;
+    const char *name; // if name != NULL search for a string
+    const uint64_t *id; // if name == NULL search for an id
 
+    // The actual data with all entries; this is where the full entry
+    // including name/id is located (the index holds an offset into data for
+    // each entry)
     const void *data;
+    // Static offset to the search key (name/id) inside the entry; after it
+    // was located by using the index's offset into data
     uint64_t offset;
 };