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