From: David Bremner <david@tethera.net>
Date: Wed, 13 Mar 2019 00:47:11 +0000 (-0300)
Subject: lib: update commentary about path/folder terms
X-Git-Tag: archive/debian/0.29_rc0-1~111
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=b22386f353fb30a0d6ccffb32b7339d69f12b85f

lib: update commentary about path/folder terms

We missed this when we changed to binary fields.
---

diff --git a/lib/database.cc b/lib/database.cc
index f33f0af6..09ab9cb0 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -124,9 +124,11 @@ typedef struct {
  *
  * In addition, terms from the content of the message are added with
  * "from", "to", "attachment", and "subject" prefixes for use by the
- * user in searching. Similarly, terms from the path of the mail
- * message are added with "folder" and "path" prefixes. But the
- * database doesn't really care itself about any of these.
+ * user in searching.
+ *
+ * The path of the containing folder is added with the "folder" prefix
+ * (see _notmuch_message_add_folder_terms).  Sub-paths of the the path
+ * of the mail message are added with the "path" prefix.
  *
  * The data portion of a mail document is empty.
  *