lib: add clarification about the use of "prefix" in the docs.

[notmuch] / lib / database.cc

diff --git a/lib/database.cc b/lib/database.cc
index fc42c4ba93c3af197de52653792c63ffc31a07c5..f33f0af6a7145a603a7ed9eb42bed44c442deba4 100644 (file)
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -63,6 +63,12 @@ typedef struct {
  * We currently have three different types of documents (mail, ghost,
  * and directory) and also some metadata.
  *
+ * There are two kinds of prefixes used in notmuch. There are the
+ * human friendly 'prefix names' like "thread:", which are also used
+ * in the query parser, and the actual prefix terms in the database
+ * (e.g. "G"). The correspondence is maintained in the file scope data
+ * structure 'prefix_table'.
+ *
  * Mail document
  * -------------
  * A mail document is associated with a particular email message. It