[PATCH] lib: reword comment about XFOLDER: prefix
[notmuch-archives.git] / b3 / 2d7e98b4d4bfcf02515985e48f003848cc6720
1 Return-Path: <bremner@tethera.net>\r
2 X-Original-To: notmuch@notmuchmail.org\r
3 Delivered-To: notmuch@notmuchmail.org\r
4 Received: from localhost (localhost [127.0.0.1])\r
5  by arlo.cworth.org (Postfix) with ESMTP id 56B7F6DE0A63\r
6  for <notmuch@notmuchmail.org>; Thu, 18 Aug 2016 01:18:49 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at cworth.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: -0.007\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=-0.007 tagged_above=-999 required=5 tests=[AWL=0.004,\r
12   SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled\r
13 Received: from arlo.cworth.org ([127.0.0.1])\r
14  by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
15  with ESMTP id 3sl36DzodAo4 for <notmuch@notmuchmail.org>;\r
16  Thu, 18 Aug 2016 01:18:48 -0700 (PDT)\r
17 Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])\r
18  by arlo.cworth.org (Postfix) with ESMTPS id BA15E6DE0A40\r
19  for <notmuch@notmuchmail.org>; Thu, 18 Aug 2016 01:18:48 -0700 (PDT)\r
20 Received: from remotemail by fethera.tethera.net with local (Exim 4.84_2)\r
21  (envelope-from <bremner@tethera.net>)\r
22  id 1baIXT-0005MZ-G3; Thu, 18 Aug 2016 04:18:59 -0400\r
23 Received: (nullmailer pid 21850 invoked by uid 1000);\r
24  Thu, 18 Aug 2016 08:18:46 -0000\r
25 From: David Bremner <david@tethera.net>\r
26 To: David Bremner <david@tethera.net>, Jani Nikula <jani@nikula.org>,\r
27  notmuch@notmuchmail.org\r
28 Subject: [PATCH] lib: reword comment about XFOLDER: prefix\r
29 Date: Thu, 18 Aug 2016 05:18:31 -0300\r
30 Message-Id: <1471508311-21806-1-git-send-email-david@tethera.net>\r
31 X-Mailer: git-send-email 2.8.1\r
32 In-Reply-To: <1471508096-19252-1-git-send-email-david@tethera.net>\r
33 References: <1471508096-19252-1-git-send-email-david@tethera.net>\r
34 X-BeenThere: notmuch@notmuchmail.org\r
35 X-Mailman-Version: 2.1.22\r
36 Precedence: list\r
37 List-Id: "Use and development of the notmuch mail system."\r
38  <notmuch.notmuchmail.org>\r
39 List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
40  <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
41 List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
42 List-Post: <mailto:notmuch@notmuchmail.org>\r
43 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
44 List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
45  <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
46 X-List-Received-Date: Thu, 18 Aug 2016 08:18:49 -0000\r
47 \r
48 I believe the current one is misleading, because in my experiments\r
49 Xapian did not add : when prefix and term were both upper case. Indeed,\r
50 it's hard to see how it could, because prefixes are added at a layer\r
51 above Xapian in our code. See _notmuch_message_add_term for an example.\r
52 \r
53 Also try to explain why this is a good idea.  As far as I can ascertain,\r
54 this is more of an issue for a system trying to work with an unknown set\r
55 of prefixes. Since notmuch has a fixed set of prefixes, and we can\r
56 hopefully be trusted not to add XGOLD and XGOLDEN as prefixes, it is\r
57 harder for problems to arise.\r
58 ---\r
59  lib/database.cc | 8 ++++----\r
60  1 file changed, 4 insertions(+), 4 deletions(-)\r
61 \r
62 diff --git a/lib/database.cc b/lib/database.cc\r
63 index 57a98c9..5577aaf 100644\r
64 --- a/lib/database.cc\r
65 +++ b/lib/database.cc\r
66 @@ -260,10 +260,10 @@ static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {\r
67      { "id",                    "Q" },\r
68      { "path",                  "P" },\r
69      /*\r
70 -     * Without the ":", since this is a multi-letter prefix, Xapian\r
71 -     * will add a colon itself if the first letter of the path is\r
72 -     * upper-case ASCII. Including the ":" forces there to always be a\r
73 -     * colon, which keeps our own logic simpler.\r
74 +     * Unconditionally add ':' to reduce potential ambiguity with\r
75 +     * overlapping prefixes and/or terms that start with capital\r
76 +     * letters. See Xapian document termprefixes.html for related\r
77 +     * discussion.\r
78       */\r
79      { "folder",                        "XFOLDER:" },\r
80  };\r
81 -- \r
82 2.8.1\r
83 \r