[PATCH 4/4] contrib: pick: document several of the tree/forest insertion functions.

diff --git a/9d/e28d321d8fefd3d0ec68b34d6bb3ccafdffe78 b/9d/e28d321d8fefd3d0ec68b34d6bb3ccafdffe78
new file mode 100644 (file)
index 0000000..3b6256c
--- /dev/null
+++ b/9d/e28d321d8fefd3d0ec68b34d6bb3ccafdffe78
@@ -0,0 +1,114 @@
+Return-Path: <markwalters1009@gmail.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 1ABA9431FCF\r
+       for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 13:06:10 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.201\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
+       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 ISlZT43H4-Ib for <notmuch@notmuchmail.org>;\r
+       Mon,  1 Jul 2013 13:06:04 -0700 (PDT)\r
+Received: from mail-wi0-f172.google.com (mail-wi0-f172.google.com\r
+       [209.85.212.172]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id B9947431FD2\r
+       for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 13:05:57 -0700 (PDT)\r
+Received: by mail-wi0-f172.google.com with SMTP id c10so3472260wiw.5\r
+       for <notmuch@notmuchmail.org>; Mon, 01 Jul 2013 13:05:56 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
+       bh=v/Y827LYLmu2WP5xLN6utW4P07nt0tO2KlAizBfFT40=;\r
+       b=YoSWNJfzlMYaKaKdlVJ2M6zzPdGyPsVQMBWmVcp77lzmodh1oV2BnElyBTVWDswG/A\r
+       mVxUlKB6vn1p0traEHFjqkxgoIrByK4+yMYLGGbb8skxyYv5V3zzpVZgg4Sgb0uWrNEU\r
+       oMHhU35QvAUag0bRF1/UwUL4q5vJ7+UqMZ9cLsoatLbAtPScrjVkoMQlY827EbA9zSa1\r
+       ACe3QPuqGpqcjfn+pKvaiXt2VyFNQDRNeJNz2yycBhNtUd1KbIE1uGd5xuqAKb5Pb3t4\r
+       LM8TyK9BJ0Ftn2HaE2TVSirYHTTksKHTpq5P4Qvrqk9bAeNR5vQkqdjo7v+xm0/itoGC\r
+       IChg==\r
+X-Received: by 10.180.108.115 with SMTP id hj19mr5377850wib.4.1372709156685;\r
+       Mon, 01 Jul 2013 13:05:56 -0700 (PDT)\r
+Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31])\r
+       by mx.google.com with ESMTPSA id\r
+       fd3sm18512618wic.10.2013.07.01.13.05.55 for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Mon, 01 Jul 2013 13:05:56 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 4/4] contrib: pick: document several of the tree/forest\r
+       insertion functions.\r
+Date: Mon,  1 Jul 2013 21:05:43 +0100\r
+Message-Id: <1372709143-12319-5-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <1372709143-12319-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1372709143-12319-1-git-send-email-markwalters1009@gmail.com>\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, 01 Jul 2013 20:06:10 -0000\r
+\r
+---\r
+ contrib/notmuch-pick/notmuch-pick.el |   12 ++++++++++--\r
+ 1 files changed, 10 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el\r
+index fd68fc6..fbd7c0b 100644\r
+--- a/contrib/notmuch-pick/notmuch-pick.el\r
++++ b/contrib/notmuch-pick/notmuch-pick.el\r
+@@ -683,7 +683,10 @@ unchanged ADDRESS if parsing fails."\r
+       (notmuch-pick-show-message)))))\r
+ \r
+ (defun notmuch-pick-insert-tree (tree depth tree-status first last)\r
+-  "Insert the message tree TREE at depth DEPTH in the current thread."\r
++  "Insert the message tree TREE at depth DEPTH in the current thread.\r
++\r
++A message tree is another name for a single sub-thread: i.e., a\r
++message together with all its descendents."\r
+   (let ((msg (car tree))\r
+       (replies (cadr tree)))\r
+ \r
+@@ -714,7 +717,7 @@ unchanged ADDRESS if parsing fails."\r
+     (notmuch-pick-insert-thread replies (1+ depth) tree-status)))\r
+ \r
+ (defun notmuch-pick-insert-thread (thread depth tree-status)\r
+-  "Insert the thread THREAD at depth DEPTH >= 1 in the current forest."\r
++  "Insert the collection of sibling sub-threads THREAD at depth DEPTH in the current forest."\r
+   (let ((n (length thread)))\r
+     (loop for tree in thread\r
+         for count from 1 to n\r
+@@ -722,12 +725,17 @@ unchanged ADDRESS if parsing fails."\r
+         do (notmuch-pick-insert-tree tree depth tree-status (eq count 1) (eq count n)))))\r
+ \r
+ (defun notmuch-pick-insert-forest-thread (forest-thread)\r
++  "Insert a single complete thread."\r
+   (let (tree-status)\r
+     ;; Reset at the start of each main thread.\r
+     (setq notmuch-pick-previous-subject nil)\r
+     (notmuch-pick-insert-thread forest-thread 0 tree-status)))\r
+ \r
+ (defun notmuch-pick-insert-forest (forest)\r
++  "Insert a forest of threads.\r
++\r
++This function inserts a collection of several complete threads as\r
++passed to it by notmuch-pick-process-filter."\r
+   (mapc 'notmuch-pick-insert-forest-thread forest))\r
+ \r
+ (defun notmuch-pick-mode ()\r
+-- \r
+1.7.9.1\r
+\r