From: David Bremner <david@tethera.net>
Date: Wed, 13 Mar 2019 00:47:10 +0000 (-0300)
Subject: lib: add clarification about the use of "prefix" in the docs.
X-Git-Tag: archive/debian/0.29_rc0-1~112
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=6b0cf9b21a8fe8b9a3cd9479e46835bb0eef024b;hp=2717ff96a70a252a9ca7afea92a07d12f2139742

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

diff --git a/lib/database.cc b/lib/database.cc
index fc42c4ba..f33f0af6 100644
--- 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