[PATCH] lib: Fix slight misinformation in the database schema doc

diff --git a/ae/e369ff5a4e127f6fa4a313fbb01757f5a11df2 b/ae/e369ff5a4e127f6fa4a313fbb01757f5a11df2
new file mode 100644 (file)
index 0000000..fff92e3
--- /dev/null
+++ b/ae/e369ff5a4e127f6fa4a313fbb01757f5a11df2
@@ -0,0 +1,104 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 1AC96431FB6\r
+       for <notmuch@notmuchmail.org>; Thu, 31 Jul 2014 19:59:28 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id FUXW3mPl7VMe for <notmuch@notmuchmail.org>;\r
+       Thu, 31 Jul 2014 19:59:24 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-2.mit.edu (dmz-mailsec-scanner-2.mit.edu\r
+       [18.9.25.13])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 22786431FAE\r
+       for <notmuch@notmuchmail.org>; Thu, 31 Jul 2014 19:59:23 -0700 (PDT)\r
+X-AuditID: 1209190d-f79c06d000002f07-79-53db028bcfb1\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-2.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 96.18.12039.B820BD35; Thu, 31 Jul 2014 22:59:23 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id s712xKlk018265; \r
+       Thu, 31 Jul 2014 22:59:21 -0400\r
+Received: from drake.dyndns.org\r
+       (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+       [216.15.114.40]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s712xJAp010496\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Thu, 31 Jul 2014 22:59:20 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1XD33v-0004Wb-DM; Thu, 31 Jul 2014 22:59:19 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] lib: Fix slight misinformation in the database schema doc\r
+Date: Thu, 31 Jul 2014 22:59:13 -0400\r
+Message-Id: <1406861953-17358-1-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 2.0.0\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFprFIsWRmVeSWpSXmKPExsUixCmqrNvNdDvYoPOPkMX1mzOZHRg9nq26\r
+       xRzAGMVlk5Kak1mWWqRvl8CV8f/iVdaCJRwVy6acZ29gPMTWxcjJISFgIvH69gQoW0ziwr31\r
+       QDYXh5DAbCaJX+8eskM4GxklJjQcYIZw7jBJ/J5zhh2kRUhgLqPE/tN1IDabgIbEtv3LGUFs\r
+       EQFpiZ13Z7N2MXJwMAuoSfzpUgEJCwt4SbQfP8UKYrMIqEo8fPaIBcTmFXCQ2H25EeoKOYmG\r
+       G5/YJjDyLmBkWMUom5JbpZubmJlTnJqsW5ycmJeXWqRrpJebWaKXmlK6iREcBJK8OxjfHVQ6\r
+       xCjAwajEw+sQeitYiDWxrLgy9xCjJAeTkihv33+gEF9SfkplRmJxRnxRaU5q8SFGCQ5mJRHe\r
+       lx+AcrwpiZVVqUX5MClpDhYlcd631lbBQgLpiSWp2ampBalFMFkZDg4lCV5WYLALCRalpqdW\r
+       pGXmlCCkmTg4QYbzAA3nAanhLS5IzC3OTIfIn2JUlAIazQCUEABJZJTmwfXCovQVozjQK8K8\r
+       jxiBqniAEQ7X/QpoMBPQ4Oe3roMMLklESEk1MHqvtbBpsw0Vsz30a+F3/r+TS6a4pif7v3td\r
+       /vnZGYltJRY3KvL9dBWN3qY9MvuQxKNt2PF8w/NNvkZ8eX2Hvghc7gxV/zZx+5MFXU+lrOQz\r
+       EqL7krN17sz7+6VGg3/+bPaMUoGH3AfPbpmvcG2nwNJ3l+9PaVuTwsC3YUJV5ILZq3LWzBD7\r
+       s1CJpTgj0VCLuag4EQDQZxrIrQIAAA==\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Fri, 01 Aug 2014 02:59:28 -0000\r
+\r
+The database schema documentation made it sound like each mail\r
+document had exactly one on-disk message file, which hasn't been true\r
+for a long time.\r
+---\r
+ lib/database.cc | 9 ++++++---\r
+ 1 file changed, 6 insertions(+), 3 deletions(-)\r
+\r
+diff --git a/lib/database.cc b/lib/database.cc\r
+index d90a924..c70ce63 100644\r
+--- a/lib/database.cc\r
++++ b/lib/database.cc\r
+@@ -55,9 +55,12 @@ typedef struct {\r
+  *\r
+  * Mail document\r
+  * -------------\r
+- * A mail document is associated with a particular email message file\r
+- * on disk. It is indexed with the following prefixed terms which the\r
+- * database uses to construct threads, etc.:\r
++ * A mail document is associated with a particular email message. It\r
++ * is stored in one or more files on disk (though only one has its\r
++ * content indexed) and is uniquely identified  by its "id" field\r
++ * (which is generally the message ID). It is indexed with the\r
++ * following prefixed terms which the database uses to construct\r
++ * threads, etc.:\r
+  *\r
+  *    Single terms of given prefix:\r
+  *\r
+-- \r
+2.0.0\r
+\r