[PATCH 2/4] emacs: help: remove duplicate bindings
authorMark Walters <markwalters1009@gmail.com>
Sat, 26 Oct 2013 21:04:37 +0000 (22:04 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:57:39 +0000 (09:57 -0800)
a0/f1851e965f7befc858b7265553fae270bc9f01 [new file with mode: 0644]

diff --git a/a0/f1851e965f7befc858b7265553fae270bc9f01 b/a0/f1851e965f7befc858b7265553fae270bc9f01
new file mode 100644 (file)
index 0000000..a20e8e6
--- /dev/null
@@ -0,0 +1,144 @@
+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 CF7AB429E57\r
+       for <notmuch@notmuchmail.org>; Sat, 26 Oct 2013 14:04:58 -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 48Nrk3-MgERl for <notmuch@notmuchmail.org>;\r
+       Sat, 26 Oct 2013 14:04:53 -0700 (PDT)\r
+Received: from mail-we0-f179.google.com (mail-we0-f179.google.com\r
+       [74.125.82.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id AFE23429E47\r
+       for <notmuch@notmuchmail.org>; Sat, 26 Oct 2013 14:04:47 -0700 (PDT)\r
+Received: by mail-we0-f179.google.com with SMTP id w61so5062816wes.24\r
+       for <notmuch@notmuchmail.org>; Sat, 26 Oct 2013 14:04:46 -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:in-reply-to:references;\r
+       bh=+yXaox7AUCm5wiR6xrev3R5WVdGZ2LBVWcjywzsciYg=;\r
+       b=dhzUMmXv9fPcAvBgxCLwvXABr4R6Bg7aQhgg69ccNK2GAG52MS58I60WFhSKk44R8x\r
+       2fWGzsdHbpzibMRiA9GQVTY2cyxsjL0pD15xvvINempMKtfWcpXuG7U6e5MaJRhb7KK/\r
+       +enfSDK01qrPQobsMhln/dStMl19JokdEqn72066z1yDganIJHHm82gBcr44sE70Eu8B\r
+       6QTcdDJWckRwcc04+tS6SpWZp7y9KmXbfra4A0IrqqT0z3RcOw5B7CsWj/P+ilqPmm7N\r
+       OiM25MlFtzz4juOOCBRMPc23FYybftO12pUgJmhfXmM+YLOgDqL9dAV4c8iLdjbkG3x2\r
+       URgg==\r
+X-Received: by 10.180.182.15 with SMTP id ea15mr3440104wic.16.1382821486349;\r
+       Sat, 26 Oct 2013 14:04:46 -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 ev4sm19391972wib.7.2013.10.26.14.04.45\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sat, 26 Oct 2013 14:04:46 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 2/4] emacs: help: remove duplicate bindings\r
+Date: Sat, 26 Oct 2013 22:04:37 +0100\r
+Message-Id: <1382821479-23384-3-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <1382821479-23384-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1382821479-23384-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: Sat, 26 Oct 2013 21:04:59 -0000\r
+\r
+If the user (or a mode) overrides a keybinding from the common keymap\r
+in one of the modes then both help lines appear in the help screen\r
+even though only one of the is applicable.\r
+\r
+Fix this by checking if we already have that key binding. We do this\r
+by constructing an list of (key . docstring) pairs so it is easy to\r
+check if we have already had that binding. Then the actual print help\r
+routine changes these pairs into strings "key \t docstring"\r
+---\r
+ emacs/notmuch.el |   38 ++++++++++++++++++++++----------------\r
+ 1 files changed, 22 insertions(+), 16 deletions(-)\r
+\r
+diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
+index f98f8cf..b9db9ba 100644\r
+--- a/emacs/notmuch.el\r
++++ b/emacs/notmuch.el\r
+@@ -141,11 +141,12 @@ This is basically just `format-kbd-macro' but we also convert ESC to M-."\r
+       (concat desc " "))))\r
\r
+ (defun notmuch-describe-keymap (keymap ua-keys &optional prefix tail)\r
+-  "Return a list of strings, each describing one binding in KEYMAP.\r
++  "Return a list of cons cells, each describing one binding in KEYMAP.\r
\r
+-Each string gives a human-readable description of the key and a\r
+-one-line description of the bound function.  See `notmuch-help'\r
+-for an overview of how this documentation is extracted.\r
++Each cons cell consists of a string giving a human-readable\r
++description of the key, and a one-line description of the bound\r
++function.  See `notmuch-help' for an overview of how this\r
++documentation is extracted.\r
\r
+ UA-KEYS should be a key sequence bound to `universal-argument'.\r
+ It will be used to describe bindings of commands that support a\r
+@@ -158,19 +159,23 @@ prefix argument.  PREFIX and TAIL are used internally."\r
+                 (notmuch-describe-keymap\r
+                  binding ua-keys (notmuch-prefix-key-description key) tail)))\r
+          (t\r
+-          (unless (not binding)\r
+-            (when (and ua-keys (symbolp binding)\r
+-                       (get binding 'notmuch-prefix-doc))\r
+-              ;; Documentation for prefixed command\r
+-              (let ((ua-desc (key-description ua-keys)))\r
+-                (push (concat ua-desc " " prefix (format-kbd-macro (vector key))\r
+-                              "\t" (get binding 'notmuch-prefix-doc))\r
+-                      tail)))\r
+-            ;; Documentation for command\r
+-            (push (concat prefix (format-kbd-macro (vector key)) "\t"\r
++          (let ((key-string (concat prefix (format-kbd-macro (vector key)))))\r
++            ;; We don't include documentation if the key-binding is\r
++            ;; over-ridden. Note, over-riding a binding\r
++            ;; automatically hides the prefixed version too.\r
++            (unless (or (assoc key-string tail) (not binding))\r
++              (when (and ua-keys (symbolp binding)\r
++                         (get binding 'notmuch-prefix-doc))\r
++                ;; Documentation for prefixed command\r
++                (let ((ua-desc (key-description ua-keys)))\r
++                  (push (cons (concat ua-desc " " prefix (format-kbd-macro (vector key)))\r
++                              (get binding 'notmuch-prefix-doc))\r
++                        tail)))\r
++              ;; Documentation for command\r
++              (push (cons key-string\r
+                           (or (and (symbolp binding) (get binding 'notmuch-doc))\r
+                               (notmuch-documentation-first-line binding)))\r
+-                  tail)))))\r
++                    tail))))))\r
+    keymap)\r
+   tail)\r
\r
+@@ -181,7 +186,8 @@ prefix argument.  PREFIX and TAIL are used internally."\r
+       (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))\r
+            (keymap (symbol-value (intern keymap-name)))\r
+            (ua-keys (where-is-internal 'universal-argument keymap t))\r
+-           (desc-list (notmuch-describe-keymap keymap ua-keys))\r
++           (desc-alist (notmuch-describe-keymap keymap ua-keys))\r
++           (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist))\r
+            (desc (mapconcat #'identity desc-list "\n")))\r
+       (setq doc (replace-match desc 1 1 doc)))\r
+       (setq beg (match-end 0)))\r
+-- \r
+1.7.9.1\r
+\r