[PATCH] notmuch_thread_get_authors: document match grouping with |

diff --git a/e1/310551717fd3ffe01014ab6d10869911992d6f b/e1/310551717fd3ffe01014ab6d10869911992d6f
new file mode 100644 (file)
index 0000000..e719cd6
--- /dev/null
+++ b/e1/310551717fd3ffe01014ab6d10869911992d6f
@@ -0,0 +1,95 @@
+Return-Path: <eg@gaute.vetsj.com>\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 24893431FBD\r
+       for <notmuch@notmuchmail.org>; Wed, 10 Sep 2014 00:23:34 -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 4oKDAAJdh7G3 for <notmuch@notmuchmail.org>;\r
+       Wed, 10 Sep 2014 00:23:28 -0700 (PDT)\r
+Received: from mail-la0-f47.google.com (mail-la0-f47.google.com\r
+       [209.85.215.47]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C3ED6431FBC\r
+       for <notmuch@notmuchmail.org>; Wed, 10 Sep 2014 00:23:27 -0700 (PDT)\r
+Received: by mail-la0-f47.google.com with SMTP id q1so1249328lam.20\r
+       for <notmuch@notmuchmail.org>; Wed, 10 Sep 2014 00:23:24 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:from:to:cc:subject:date:message-id;\r
+       bh=8THwH1TqJi8m4jqXuuyPoU11Px34PTy8icmfKvGrMAI=;\r
+       b=jgYTjmyitE/0xmFLgiYyIjvzZVTKc1v17vgQOYX1utA3ROiCZTlN4D4CWy3jLeTcNx\r
+       YZrReIZ/eAr5I+7b9iU8H+Sj18SDXbcsQuLZc0Aw0eea+ydI25F7TYU4ZL86DvWbh+WX\r
+       wMtmPCLWB+y4cKoMnxTBUu6gXToRkHe8lAgZ/QZAM/+cBBE783K7PUMJzMYfvenGOGbN\r
+       d2AbKnsbeAezK+Q6xgCTy49oTTeKWfGL07RwidlaPPdNJPQVeU0Tv5F+Qmsy2hoPuuu9\r
+       ytmV9Y4WnZcGq21oUfjw8lietudUHxAbl8GsO438KpY+Jm3neShhAc0JaMTFc/ebilN1\r
+       uk8g==\r
+X-Gm-Message-State:\r
+ ALoCoQltkEmhvYTqV5GO+kOgz8oMz5SNzAKE5dScuzNzS5+YAATqOnKbTftoPeiWqkyns1yQ/+3a\r
+X-Received: by 10.112.148.133 with SMTP id ts5mr38591173lbb.45.1410333802903; \r
+       Wed, 10 Sep 2014 00:23:22 -0700 (PDT)\r
+Received: from localhost (cD572BF51.dhcp.as2116.net. [81.191.114.213])\r
+       by mx.google.com with ESMTPSA id ue4sm5340499lbc.0.2014.09.10.00.23.21\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+       Wed, 10 Sep 2014 00:23:22 -0700 (PDT)\r
+From: Gaute Hope <eg@gaute.vetsj.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] notmuch_thread_get_authors: document match grouping with |\r
+Date: Wed, 10 Sep 2014 09:24:18 +0200\r
+Message-Id: <1410333858-14573-1-git-send-email-eg@gaute.vetsj.com>\r
+X-Mailer: git-send-email 2.1.0\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: Wed, 10 Sep 2014 07:23:34 -0000\r
+\r
+as stated in thread.cc:115\r
+\r
+/* Construct an authors string from matched_authors_array and\r
+ * authors_array. The string contains matched authors first, then\r
+ * non-matched authors (with the two groups separated by '|'). Within\r
+ * each group, authors are listed in date order. */\r
+\r
+this is, however, not reflected in the public API documentation in\r
+notmuch.h:970. This patch a paragraph explaining how | separates the\r
+group of authors of messages matching the query and those of messages\r
+that do not, but are still contained in the thread.\r
+---\r
+ lib/notmuch.h | 4 ++++\r
+ 1 file changed, 4 insertions(+)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index 21a5225..fe2340b 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -973,6 +973,10 @@ notmuch_thread_get_matched_messages (notmuch_thread_t *thread);\r
+  * authors of mail messages in the query results that belong to this\r
+  * thread.\r
+  *\r
++ * The string contains authors of messages matching the query first, then\r
++ * non-matched authors (with the two groups separated by '|'). Within\r
++ * each group, authors are ordered by date.\r
++ *\r
+  * The returned string belongs to 'thread' and as such, should not be\r
+  * modified by the caller and will only be valid for as long as the\r
+  * thread is valid, (which is until notmuch_thread_destroy or until\r
+-- \r
+2.1.0\r
+\r