8b/9032379c1c519f1d0b459957ac25991055f19a

   1 Return-Path: <markwalters1009@gmail.com>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 6B69F429E3D\r
   6         for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 00:54:22 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0.201\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
  12         tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
  13         FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
  14         RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  15 Received: from olra.theworths.org ([127.0.0.1])\r
  16         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  17         with ESMTP id nasxeTWVJMa3 for <notmuch@notmuchmail.org>;\r
  18         Mon,  1 Jul 2013 00:54:17 -0700 (PDT)\r
  19 Received: from mail-wi0-f171.google.com (mail-wi0-f171.google.com\r
  20         [209.85.212.171]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
  21         (No client certificate requested)\r
  22         by olra.theworths.org (Postfix) with ESMTPS id B0413429E25\r
  23         for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 00:54:12 -0700 (PDT)\r
  24 Received: by mail-wi0-f171.google.com with SMTP id hj3so2739645wib.16\r
  25         for <notmuch@notmuchmail.org>; Mon, 01 Jul 2013 00:54:11 -0700 (PDT)\r
  26 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
  27         h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
  28         bh=e9RqSZcBg2aH5OcYioasIwwsthcwWn4EGHB81gaGlpY=;\r
  29         b=pubqcFwwCUhHAS5F0bCPr6xpdD5Bt2Gc1YI35I27O+mz4BHS/p7EKvrfNO5xY5qaIf\r
  30         ovAERHV7P6Q5oXsgAfSDDPkb12JCocQhMu2gKqJO+n1hC4WbYzNVabCCC3D4iw4oRKXU\r
  31         L//jzfEF44dwfkRTBF5v8qqAF6V6kS2zVlWlkLzZ9w6xQ22HjGvaQpQ6UCcfDJgTJfjI\r
  32         pTShM51nxn+CsX83znC+UmYPw0n3lOMgj4npLGdBN6NgGU46kZZ8d1jxZlHIoaekbQpP\r
  33         YyEERG46+zBDBPQif70lhAti2FlWTFyrP4wh6xCdp08niRlkxzcuEQEOM0Mn+Z+FeEz5\r
  34         MHpg==\r
  35 X-Received: by 10.180.85.8 with SMTP id d8mr11246369wiz.13.1372665251636;\r
  36         Mon, 01 Jul 2013 00:54:11 -0700 (PDT)\r
  37 Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31])\r
  38         by mx.google.com with ESMTPSA id b20sm14513475wiw.4.2013.07.01.00.54.10\r
  39         for <multiple recipients>\r
  40         (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
  41         Mon, 01 Jul 2013 00:54:11 -0700 (PDT)\r
  42 From: Mark Walters <markwalters1009@gmail.com>\r
  43 To: notmuch@notmuchmail.org\r
  44 Subject: [PATCH 2/5] contrib: pick: add docstrings to all defvars\r
  45 Date: Mon,  1 Jul 2013 08:54:00 +0100\r
  46 Message-Id: <1372665243-7675-3-git-send-email-markwalters1009@gmail.com>\r
  47 X-Mailer: git-send-email 1.7.9.1\r
  48 In-Reply-To: <1372665243-7675-1-git-send-email-markwalters1009@gmail.com>\r
  49 References: <1372665243-7675-1-git-send-email-markwalters1009@gmail.com>\r
  50 X-BeenThere: notmuch@notmuchmail.org\r
  51 X-Mailman-Version: 2.1.13\r
  52 Precedence: list\r
  53 List-Id: "Use and development of the notmuch mail system."\r
  54         <notmuch.notmuchmail.org>\r
  55 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  56         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  57 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  58 List-Post: <mailto:notmuch@notmuchmail.org>\r
  59 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  60 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  61         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  62 X-List-Received-Date: Mon, 01 Jul 2013 07:54:22 -0000\r
  63 \r
  64 ---\r
  65  contrib/notmuch-pick/notmuch-pick.el |   45 ++++++++++++++++++++++-----------\r
  66  1 files changed, 30 insertions(+), 15 deletions(-)\r
  67 \r
  68 diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el\r
  69 index 287c3e5..cce3cb7 100644\r
  70 --- a/contrib/notmuch-pick/notmuch-pick.el\r
  71 +++ b/contrib/notmuch-pick/notmuch-pick.el\r
  72 @@ -146,35 +146,50 @@\r
  73    :group 'notmuch-pick\r
  74    :group 'notmuch-faces)\r
  75  \r
  76 -(defvar notmuch-pick-previous-subject "")\r
  77 +(defvar notmuch-pick-previous-subject\r
  78 +  "The subject of the most recent result shown during the async display")\r
  79  (make-variable-buffer-local 'notmuch-pick-previous-subject)\r
  80  \r
  81 -;; The basic query i.e. the key part of the search request.\r
  82 -(defvar notmuch-pick-basic-query nil)\r
  83 +(defvar notmuch-pick-basic-query nil\r
  84 +  "A buffer local copy of argument query to the function notmuch-pick")\r
  85  (make-variable-buffer-local 'notmuch-pick-basic-query)\r
  86 -;; The context of the search: i.e., useful but can be dropped.\r
  87 -(defvar notmuch-pick-query-context nil)\r
  88 +\r
  89 +(defvar notmuch-pick-query-context nil\r
  90 +  "A buffer local copy of argument query-context to the function notmuch-pick")\r
  91  (make-variable-buffer-local 'notmuch-pick-query-context)\r
  92 -(defvar notmuch-pick-target-msg nil)\r
  93 +\r
  94 +(defvar notmuch-pick-target-msg nil\r
  95 +  "A buffer local copy of argument target to the function notmuch-pick")\r
  96  (make-variable-buffer-local 'notmuch-pick-target-msg)\r
  97 -(defvar notmuch-pick-open-target nil)\r
  98 +\r
  99 +(defvar notmuch-pick-open-target nil\r
 100 +  "A buffer local copy of argument open-target to the function notmuch-pick")\r
 101  (make-variable-buffer-local 'notmuch-pick-open-target)\r
 102 -(defvar notmuch-pick-buffer-name nil)\r
 103 +\r
 104 +(defvar notmuch-pick-buffer-name nil\r
 105 +  "A buffer local copy of argument buffer-name to the function notmuch-pick")\r
 106  (make-variable-buffer-local 'notmuch-pick-buffer-name)\r
 107 -;; This variable is the window used for the message pane. It is set\r
 108 -;; in both the parent pick buffer and the child show buffer. It is\r
 109 -;; used to try and close the message pane when quitting pick or the\r
 110 -;; child show buffer.\r
 111 -(defvar notmuch-pick-message-window nil)\r
 112 +\r
 113 +(defvar notmuch-pick-message-window nil\r
 114 +  "The window of the message pane.\r
 115 +\r
 116 +It is set in both the pick buffer and the child show buffer. It\r
 117 +is used to try and close the message pane when quitting pick or\r
 118 +the child show buffer.")\r
 119  (make-variable-buffer-local 'notmuch-pick-message-window)\r
 120  (put 'notmuch-pick-message-window 'permanent-local t)\r
 121 -(defvar notmuch-pick-message-buffer nil)\r
 122 +\r
 123 +(defvar notmuch-pick-message-buffer nil\r
 124 +  "The buffer name of the show buffer in the message pane.\r
 125 +\r
 126 +This is used to try and make sure we don't close the message pane\r
 127 +if the user has loaded a different buffer in that window.")\r
 128  (make-variable-buffer-local 'notmuch-pick-message-buffer-name)\r
 129  (put 'notmuch-pick-message-buffer-name 'permanent-local t)\r
 130 +\r
 131  (defvar notmuch-pick-process-state nil\r
 132    "Parsing state of the search process filter.")\r
 133  \r
 134 -\r
 135  (defvar notmuch-pick-mode-map\r
 136    (let ((map (make-sparse-keymap)))\r
 137      (define-key map [mouse-1] 'notmuch-pick-show-message)\r
 138 -- \r
 139 1.7.9.1\r
 140 \r