Re: [PATCH v5] devel/emacs: add devel/try-emacs-mua
authorTomi Ollila <tomi.ollila@iki.fi>
Tue, 5 Jan 2016 20:36:54 +0000 (22:36 +0200)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 21:50:21 +0000 (14:50 -0700)
10/9e5ca400ec0f0b1be8177be087188f52eea89a [new file with mode: 0644]

diff --git a/10/9e5ca400ec0f0b1be8177be087188f52eea89a b/10/9e5ca400ec0f0b1be8177be087188f52eea89a
new file mode 100644 (file)
index 0000000..757c455
--- /dev/null
@@ -0,0 +1,223 @@
+Return-Path: <tomi.ollila@iki.fi>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 191D46DE13DB\r
+ for <notmuch@notmuchmail.org>; Tue,  5 Jan 2016 12:36:43 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.671\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.671 tagged_above=-999 required=5 tests=[AWL=0.019, \r
+ SPF_NEUTRAL=0.652] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id FeVT0yV_0emg for <notmuch@notmuchmail.org>;\r
+ Tue,  5 Jan 2016 12:36:40 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 96EA86DE13AF\r
+ for <notmuch@notmuchmail.org>; Tue,  5 Jan 2016 12:36:39 -0800 (PST)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+ by guru.guru-group.fi (Postfix) with ESMTP id 19AF01000CD;\r
+ Tue,  5 Jan 2016 22:36:55 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: Michal Sojka <sojkam1@fel.cvut.cz>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v5] devel/emacs: add devel/try-emacs-mua\r
+In-Reply-To: <87egdxx78z.fsf@steelpick.2x.cz>\r
+References: <1451946112-23573-1-git-send-email-tomi.ollila@iki.fi>\r
+ <87egdxx78z.fsf@steelpick.2x.cz>\r
+User-Agent: Notmuch/0.21+32~g73439f8 (http://notmuchmail.org) Emacs/24.3.1\r
+ (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+ $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+ !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Tue, 05 Jan 2016 22:36:54 +0200\r
+Message-ID: <m2r3hvu5jt.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://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: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 05 Jan 2016 20:36:43 -0000\r
+\r
+On Tue, Jan 05 2016, Michal Sojka <sojkam1@fel.cvut.cz> wrote:\r
+\r
+> Hi Tomi,\r
+>\r
+> this looks almost good. A few minor comments below.\r
+>\r
+> On Mon, Jan 04 2016, Tomi Ollila wrote:\r
+>> devel/try-emacs-mua provides an easy way to try and experiment\r
+>> with the notmuch emacs client distributed in emacs subdirectory of\r
+>> the notmuch source tree.\r
+>>\r
+>> try-emacs-mua starts a new emacs process and if initial checks pass\r
+>> *scratch* buffer is filled with information of how to begin.\r
+>>\r
+>> Normal emacs command line arguments can be used, like -q or -Q.\r
+>> These arguments are appended verbatim to the starting emacs process.\r
+>>\r
+>> If the emacs version in use is smaller than 24.4, special care is taken\r
+>> to ensure that notmuch*.elc files older than corresponding .el files\r
+>> are not loaded. Since emacs 24.4, setting `load-prefer-newer' variable\r
+>> takes care of this.\r
+>> ---\r
+>>\r
+>> Thanks to Michal for review of v4\r
+>> id:1450610032-23776-1-git-send-email-tomi.ollila@iki.fi\r
+>> in id:87vb7aco77.fsf@steelpick.2x.cz\r
+>>\r
+>> This should address the issues:\r
+>>\r
+>> 1) no more command line filtering\r
+>> 2) dropped (outcommented) file-truename advising\r
+>> 3) added information which notmuch binary is used\r
+>> 4) dropped popping messages buffer (fixing 2 issues)\r
+>>\r
+>> Added:\r
+>> * code to load ~/.emacs.d/notmuch-config.el if exists and not loaded already\r
+>> * pop messages buffer if (require 'notmuch) fails\r
+>> * don't suggest package-initialize if emacs version is 23\r
+>>\r
+>>\r
+>>  devel/try-emacs-mua | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+>>  1 file changed, 156 insertions(+)\r
+>>  create mode 100755 devel/try-emacs-mua\r
+>>\r
+>> diff --git a/devel/try-emacs-mua b/devel/try-emacs-mua\r
+>> new file mode 100755\r
+>> index 000000000000..0236b438c30a\r
+>> --- /dev/null\r
+>> +++ b/devel/try-emacs-mua\r
+>> @@ -0,0 +1,156 @@\r
+>> +#!/bin/sh\r
+>> +:; set -x; exec "${EMACS:-emacs}" --debug-init --load "$0" "$@"; exit\r
+>> +;;\r
+>> +;; Try the notmuch emacs client located in ../notmuch/emacs directory\r
+>> +;;\r
+>> +;; Run this without arguments; emacs window opens with some usage information\r
+>> +;;\r
+>> +;; Authors: Tomi Ollila <tomi.ollila@iki.fi>\r
+>> +;;\r
+>> +;; http://www.emacswiki.org/emacs/EmacsScripts was a useful starting point...\r
+>> +;;\r
+>> +;; Licence: GPLv3+\r
+>> +;;\r
+>> +\r
+>> +(message "Starting '%s'" load-file-name)\r
+>> +\r
+>> +(set-buffer "*scratch*")\r
+>> +\r
+>> +(setq initial-buffer-choice t) ;; *scratch* buffer\r
+>\r
+> After initial tuning of emacs configuration according to the hints in\r
+> the scratch buffer, people might want to automate things. For example\r
+> something like:\r
+>\r
+>     devel/try-emacs-mua -q -f notmuch-hello\r
+>\r
+> This does not work as one would expect, because the notmuch-hello buffer\r
+> is buried under the *scratch* buffer. To get the hello screen after the\r
+> start one has to run:\r
+>\r
+>     devel/try-emacs-mua -q -f notmuch-hello --eval '(setq initial-buffer-choice nil)'\r
+\r
+Simpler is to change the above code line to:\r
+\r
+(setq initial-buffer-choice nil\r
+      inhibit-startup-screen t)\r
+\r
+Now the visible buffer is *scratch* by default -- and works more closely\r
+how emacs works normally.\r
+\r
+> This could be also documented in the scratch buffer. Or it might be\r
+> easier, in this case, to run emacs without this script at all. There\r
+> will be no logging, but this might be OK for some people.\r
+>\r
+> Actually I don't know who are you writing this script for? For notmuch\r
+> developers or for users who want to debug or test development version? \r
+\r
+First of all, for me & other notmuch developers. After a few months break\r
+when I do some notmuch elisp coding and try to test it I hope I don't have\r
+to remember so much setup things and if something initially goes wrong I\r
+might get visible hints to the screen.\r
+\r
+And also to users to test development version -- or any other version by\r
+copying this file to notmuch/devel *OR* notmuch/emacs directory (works\r
+from both locations). And when they run and get into problems, posting\r
+the contents of *Messages* buffer may provide useful information.\r
+\r
+>> +\r
+>> +(when (featurep 'notmuch)\r
+>> +  (insert "\r
+>> +Notmuch has been loaded to this emacs (during processing of the init file)\r
+>> +which means it is (most probably) loaded from different source than expected.\r
+>> +\r
+>> +Please run \"" (file-name-nondirectory load-file-name)\r
+>> +"\" with '-q' (or '-Q') as an argument, to disable\r
+>> +processing of the init file -- you can load it after emacs has started\n\r
+>> +exit emacs (y or n)? ")\r
+>> +  (if (y-or-n-p "exit emacs")\r
+>> +      (kill-emacs)\r
+>> +    (error "Stopped reading %s" load-file-name)))\r
+>> +\r
+>> +(let ((pdir (file-name-directory\r
+>> +        (directory-file-name (file-name-directory load-file-name)))))\r
+>> +  (unless (file-exists-p (concat pdir "emacs/notmuch-lib.el"))\r
+>> +    (insert "Cannot find notmuch-emacs source directory\r
+>> +while looking at: " pdir "emacs\n\nexit emacs (y or n)? ")\r
+>> +    (if (y-or-n-p "exit emacs")\r
+>> +   (kill-emacs)\r
+>> +      (error "Stopped reading %s" load-file-name)))\r
+>> +  (setq try-notmuch-source-directory (directory-file-name pdir))\r
+>> +  (setq try-notmuch-emacs-directory (concat pdir "emacs/"))\r
+>> +  (setq load-path (cons try-notmuch-emacs-directory load-path)))\r
+>> +\r
+>> +;; they say advice doesn't work for primitives (functions from c source)\r
+>> +;; well, these 'before' advice works for emacs 23.1 - 24.5 (at least)\r
+>> +;; ...and for our purposes 24.3 is enough (there is no load-prefer-newer there)\r
+>> +;; note also that the old, "obsolete" defadvice mechanism was used, but that\r
+>> +;; is the only one available for emacs 23 and 24 up to 24.3.\r
+>> +\r
+>> +(if (boundp 'load-prefer-newer)\r
+>> +    (defadvice require (before before-require activate)\r
+>> +      (unless (featurep feature)\r
+>> +   (message "require: %s" feature)))\r
+>> +  ;; else: special require "short-circuit"; after load feature is provided...\r
+>> +  ;; ... in notmuch sources we always use require and there are no loops\r
+>> +  (defadvice require (before before-require activate)\r
+>> +    (unless (featurep feature)\r
+>> +      (message "require: %s" feature)\r
+>> +      (let ((name (symbol-name feature)))\r
+>> +   (if (and (string-match "^notmuch" name)\r
+>> +            (file-newer-than-file-p\r
+>> +             (concat try-notmuch-emacs-directory name ".el")\r
+>> +             (concat try-notmuch-emacs-directory name ".elc")))\r
+>> +       (load (concat try-notmuch-emacs-directory name ".el") nil nil t t)\r
+>> +     )))))\r
+>> +\r
+>> +(insert "Found notmuch emacs client in " try-notmuch-emacs-directory "\n")\r
+>> +\r
+>> +(let ((notmuch-path (executable-find "notmuch")))\r
+>> +  (insert "Notmuch cli executable "\r
+>\r
+> Nitpick: I'd prefer CLI in all caps.\r
+\r
+That looks better to me, too.\r
+\r
+>\r
+> Thanks.\r
+> -Michal\r
+\r
+Thanks for the review,\r
+\r
+Tomi\r