[PATCH 7/6] emacs: Improved `notmuch-describe-keymap' documentation

diff --git a/3c/ad0e32af1e48828830044eb8fcb7c0bf063988 b/3c/ad0e32af1e48828830044eb8fcb7c0bf063988
new file mode 100644 (file)
index 0000000..4952368
--- /dev/null
+++ b/3c/ad0e32af1e48828830044eb8fcb7c0bf063988
@@ -0,0 +1,101 @@
+Return-Path: <amdragon@mit.edu>\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 32275431FAF\r
+       for <notmuch@notmuchmail.org>; Mon,  7 Oct 2013 15:49:09 -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 r8r8RkppMl6T for <notmuch@notmuchmail.org>;\r
+       Mon,  7 Oct 2013 15:49:03 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-4.mit.edu (dmz-mailsec-scanner-4.mit.edu\r
+       [18.9.25.15])\r
+       by olra.theworths.org (Postfix) with ESMTP id DD715431FAE\r
+       for <notmuch@notmuchmail.org>; Mon,  7 Oct 2013 15:49:02 -0700 (PDT)\r
+X-AuditID: 1209190f-b7fa08e0000009c6-11-52533a5e106b\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       by dmz-mailsec-scanner-4.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id A1.CB.02502.E5A33525; Mon,  7 Oct 2013 18:49:02 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id r97Mn020026104; \r
+       Mon, 7 Oct 2013 18:49:00 -0400\r
+Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r97Mmxlc001039\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Mon, 7 Oct 2013 18:49:00 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1VTJbm-0007BG-Gi; Mon, 07 Oct 2013 18:48:58 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 7/6] emacs: Improved `notmuch-describe-keymap' documentation\r
+Date: Mon,  7 Oct 2013 18:48:51 -0400\r
+Message-Id: <1381186131-27552-1-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <1381029768-11883-1-git-send-email-amdragon@mit.edu>\r
+References: <1381029768-11883-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixG6nrhtnFRxk8HSugsX1mzOZHRg9nq26\r
+       xRzAGMVlk5Kak1mWWqRvl8CVsfVWI2vBBM6K1fs+sTcwrmfvYuTkkBAwkdi89gUzhC0mceHe\r
+       erYuRi4OIYF9jBKNi3exQjgbGCWOzT/DAlIlJHCYSWLHKS4Iey6jxPkp0iA2m4CGxLb9yxlB\r
+       bBEBaYmdd2cDNXNwMAuoSfzpUgEJCwv4SNy8s4ANxGYRUJVoa3kJtphXwEHiwJWHLBBHKEks\r
+       PLWNFcTmFHCU2HzqDSPEKgeJ68ufM05g5F/AyLCKUTYlt0o3NzEzpzg1Wbc4OTEvL7VI10Qv\r
+       N7NELzWldBMjKGQ4Jfl3MH47qHSIUYCDUYmHN+NoUJAQa2JZcWXuIUZJDiYlUd4ey+AgIb6k\r
+       /JTKjMTijPii0pzU4kOMEhzMSiK8AkZAOd6UxMqq1KJ8mJQ0B4uSOO9NDvsgIYH0xJLU7NTU\r
+       gtQimKwMB4eSBG8kyFDBotT01Iq0zJwShDQTByfIcB6g4fNAaniLCxJzizPTIfKnGBWlxHln\r
+       gyQEQBIZpXlwvbCYfsUoDvSKMO8OkCoeYDqA634FNJgJaLAueyDI4JJEhJRUA2Mtj6egzNTE\r
+       oobOfo/cWdc6NfetE2U0Fd4eO/3wb9HDEWLrVqzxOHHxSstnJy0hrSMm7adSzvH0h/08Zh22\r
+       iuPGeaf4U08rvJ/s32qS5dXNVmDGz2c6o0vlU2PMraM5+57tD9yRHtfEzqa8qDrb+w6LxSsB\r
+       JksNx74FTj3F65ba2IfGrHa5o8RSnJFoqMVcVJwIAPJbaN/EAgAA\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, 07 Oct 2013 22:49:09 -0000\r
+\r
+---\r
+ emacs/notmuch.el | 11 ++++++++---\r
+ 1 file changed, 8 insertions(+), 3 deletions(-)\r
+\r
+diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
+index e559472..c47c6b5 100644\r
+--- a/emacs/notmuch.el\r
++++ b/emacs/notmuch.el\r
+@@ -141,10 +141,15 @@ 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 key in KEYMAP.\r
++  "Return a list of strings, each describing one binding in KEYMAP.\r
+ \r
+-Each string gives a human-readable description of the key and the\r
+-first line of documentation for the bound function."\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
++\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
++prefix argument.  PREFIX and TAIL are used internally."\r
+   (map-keymap\r
+    (lambda (key binding)\r
+      (cond ((mouse-event-p key) nil)\r
+-- \r
+1.8.4.rc3\r
+\r