[PATCH 1/6] lib: Correct out-of-date doc comment

diff --git a/9c/9a9fc0f5da7625af2fc3453a23ff0d93462581 b/9c/9a9fc0f5da7625af2fc3453a23ff0d93462581
new file mode 100644 (file)
index 0000000..3e8b11b
--- /dev/null
+++ b/9c/9a9fc0f5da7625af2fc3453a23ff0d93462581
@@ -0,0 +1,99 @@
+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 34C79431FD0\r
+       for <notmuch@notmuchmail.org>; Mon, 12 Aug 2013 11:40:59 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 DX+DxqMv2KUi for <notmuch@notmuchmail.org>;\r
+       Mon, 12 Aug 2013 11:40:53 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu\r
+       [18.7.68.37])\r
+       by olra.theworths.org (Postfix) with ESMTP id DFFEA431FAF\r
+       for <notmuch@notmuchmail.org>; Mon, 12 Aug 2013 11:40:52 -0700 (PDT)\r
+X-AuditID: 12074425-b7f0c8e000000953-9f-52092c34f7bb\r
+Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\r
+       by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 09.BF.02387.43C29025; Mon, 12 Aug 2013 14:40:52 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id r7CIepwH029101; \r
+       Mon, 12 Aug 2013 14:40:51 -0400\r
+Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
+       (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 r7CIemSB003741\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Mon, 12 Aug 2013 14:40:50 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1V8x2u-0005yU-K1; Mon, 12 Aug 2013 14:40:48 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 1/6] lib: Correct out-of-date doc comment\r
+Date: Mon, 12 Aug 2013 14:40:34 -0400\r
+Message-Id: <1376332839-22825-2-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1376332839-22825-1-git-send-email-amdragon@mit.edu>\r
+References: <1376332839-22825-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixCmqrWuiwxlkMOeVvMX1mzOZHRg9nq26\r
+       xRzAGMVlk5Kak1mWWqRvl8CVMeXBP7aCuRwVD7/tZm9gPMnWxcjJISFgIrFl62x2CFtM4sK9\r
+       9UBxLg4hgX2MElvbFzBDOBsZJU5s7mEEqRISOMIksXy5JURiLqPE9dNdYO1sAhoS2/YvBysS\r
+       EZCW2Hl3NmsXIwcHs4CaxJ8uFRBTWMBS4tVKeZAKFgFViTv3t4B18go4SEy8/5cZ4ghFie5n\r
+       E8CO4xRwlLi//BwLxFoHiY27ehgnMPIvYGRYxSibklulm5uYmVOcmqxbnJyYl5dapGuhl5tZ\r
+       opeaUrqJERQy7C6qOxgnHFI6xCjAwajEw5vxkSNIiDWxrLgy9xCjJAeTkijvJE3OICG+pPyU\r
+       yozE4oz4otKc1OJDjBIczEoivFtYgXK8KYmVValF+TApaQ4WJXHe50/PBgoJpCeWpGanphak\r
+       FsFkZTg4lCR4hbSBGgWLUtNTK9Iyc0oQ0kwcnCDDeYCGu4PU8BYXJOYWZ6ZD5E8xKkqJ81qA\r
+       JARAEhmleXC9sJh+xSgO9IowryBIFQ8wHcB1vwIazAQ02KiZA2RwSSJCSqqBUcG0Okn3ZbJ4\r
+       q5HeascPproWE2IbVKW25L4Vsdrto2UavUngYObxjl1utzvqbu5ctlLgZOWHHQq3hCJdBG+t\r
+       9tjaxbh8c+NTz+DDHlP0zFckXVfwmy1udON54+ToX3sFurgtvT3bp5x+umy7lzjLZTZD72xr\r
+       Sdkjt/auF57E7f+a7cC9FGN2JZbijERDLeai4kQAaO/GcsQCAAA=\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: Mon, 12 Aug 2013 18:40:59 -0000\r
+\r
+notmuch_message_get_header started returning some headers straight\r
+from the database in 567bcbc, but this comment explicitly claimed all\r
+headers were read from the message file.\r
+---\r
+ lib/notmuch.h |    7 +++++--\r
+ 1 file changed, 5 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index 73c85a4..9fc34ef 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -1015,8 +1015,11 @@ notmuch_message_get_date  (notmuch_message_t *message);\r
+ \r
+ /* Get the value of the specified header from 'message'.\r
+  *\r
+- * The value will be read from the actual message file, not from the\r
+- * notmuch database. The header name is case insensitive.\r
++ * Common headers are stored in the database when the message is\r
++ * indexed and will be returned from the database.  Other headers will\r
++ * be read from the actual message file.\r
++ *\r
++ * The header name is case insensitive.\r
+  *\r
+  * The returned string belongs to the message so should not be\r
+  * modified or freed by the caller (nor should it be referenced after\r
+-- \r
+1.7.10.4\r
+\r