From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Joseph Turner via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#63336: [PATCH] package-vc: Process :make and :shell-command spec args Date: Wed, 10 May 2023 18:37:15 -0700 Message-ID: <873540rqkm.fsf@breatheoutbreathe.in> References: <874joprxmx.fsf@breatheoutbreathe.in> <87jzxkecnk.fsf@posteo.net> <87pm7b7up0.fsf@breatheoutbreathe.in> <877ctghey0.fsf@posteo.net> Reply-To: Joseph Turner Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35695"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 63336@debbugs.gnu.org To: Philip Kaludercic Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat May 13 21:16:28 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pxujC-00094T-R1 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 13 May 2023 21:16:27 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pxuit-0001i1-AD; Sat, 13 May 2023 15:16:07 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pxuio-0001hh-NJ for bug-gnu-emacs@gnu.org; Sat, 13 May 2023 15:16:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pxuio-00051P-ED for bug-gnu-emacs@gnu.org; Sat, 13 May 2023 15:16:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pxuin-0008O6-Ud for bug-gnu-emacs@gnu.org; Sat, 13 May 2023 15:16:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Joseph Turner Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 13 May 2023 19:16:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 63336 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 63336-submit@debbugs.gnu.org id=B63336.168400531332186 (code B ref 63336); Sat, 13 May 2023 19:16:01 +0000 Original-Received: (at 63336) by debbugs.gnu.org; 13 May 2023 19:15:13 +0000 Original-Received: from localhost ([127.0.0.1]:39670 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pxui1-0008N2-4i for submit@debbugs.gnu.org; Sat, 13 May 2023 15:15:13 -0400 Original-Received: from out-57.mta1.migadu.com ([95.215.58.57]:11563) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pxuhz-0008Mu-5M for 63336@debbugs.gnu.org; Sat, 13 May 2023 15:15:12 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=breatheoutbreathe.in; s=key1; t=1684005309; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=vYQR5y1u0olTWIMDqXeKTCvHbgpBds47qRBDxH5Dx+c=; b=SNEp1rT977o0RUSltV572rEx3lodWZTV9IXv1//d4ytMXLn9F7wvKol5apaoTjvePaBWSq 4pQs8+iuLufe4PTocIphHgPijKMxKXoqjk3jRFTxumfDzuxrKJU9tfF85sUxPcE2SkjJ4T Ekv2cBY1+zv5cceYNQf6eOg73tp/DX4= X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <877ctghey0.fsf@posteo.net> X-Migadu-Flow: FLOW_OUT X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:261696 Archived-At: --=-=-= Content-Type: text/plain Philip Kaludercic writes: > Joseph Turner writes: > >>>> +(defun package-vc--make (pkg-spec dir) >>>> + "Process :make and :shell-command spec arguments." >>>> + (let ((target (plist-get pkg-spec :make)) >>>> + (cmd (plist-get pkg-spec :shell-command))) >>>> + (when (or cmd target) >>>> + (with-current-buffer (get-buffer-create " *package-vc make*") >>> ^ >>> should the package name >>> be mentioned here? >> >> I like this idea, but IIUC package-vc--make would then need to take an >> extra arg, since pkg-spec doesn't contain the :name of the package. We >> could also add :name to the pkg-spec plist? > > I wouldn't be in favour of that, I think that passing the name as a > separate argument would be a better solution. I agree. >> For comparison, package-vc--build-documentation creates a buffer called >> " *package-vc doc*" without the package name. > > The difference I see here is that documentation usually builds fine, > while :make or :shell-command have a higher chance of failing because > some software is missing, especially if people don't use :make the way > it is used on the ELPA server but to build external dependencies (I'm > thinking of mail clients like notmuch) That makes sense to me. In the attached patch, I pass pkg-desc to package-vc--make instead just name. Want me to submit a separate patch which adds the package name to the " *package-vc doc*" buffer name? >>>> + target (buffer-name))))))) >>>> + >>>> (declare-function org-export-to-file "ox" (backend file)) >>>> >>>> (defun package-vc--build-documentation (pkg-desc file) >>>> @@ -486,6 +515,9 @@ documentation and marking the package as installed." >>>> ;; Generate package file >>>> (package-vc--generate-description-file pkg-desc pkg-file) >>>> >>>> + ;; Process :make and :shell-command arguments before building documentation >>>> + (when package-vc-process-make (package-vc--make pkg-spec pkg-dir)) >>> >>> Wasn't the plan to allow `package-vc-process-make' to either be a >>> generic "build-anything" or a selective listing of packages where we >>> allow :make and :shell-command to be executed? >> >> Let me know if the attached commit accomplishes what you had in mind. > > Yes, that (or rather the newest version from a different message) looks good. > >>>> + >>>> ;; Detect a manual >>>> (when (executable-find "install-info") >>>> (dolist (doc-file (ensure-list (plist-get pkg-spec :doc))) >>> >>> Otherwise this looks good, but I haven't tried it out yet. >> >> I fixed up a couple other issues: >> >> - removed unnecessary dir arg to package-vc--make >> - added function arg to the docstring for package-vc--make >> >> I'm not sure if the customization type for package-vc-process-make is >> correct. Please double check that. >> >> Also, should users be able to run :make and :shell-command args defined >> in a spec passed into package-vc-install? > > Yes, is that currently not supported? Nevermind! It is supported. I didn't notice that package-vc--unpack adds the user-defined pkg-spec to package-vc-selected-packages just before calling package-vc--unpack-1. Best, Joseph --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-package-vc-Process-make-and-shell-command-spec-args.patch >From b27724197acd4ee72f9d336843f0e6ed9fcee87b Mon Sep 17 00:00:00 2001 From: Joseph Turner Date: Sat, 13 May 2023 10:05:04 -0700 Subject: [PATCH] package-vc: Process :make and :shell-command spec args --- lisp/emacs-lisp/package-vc.el | 37 +++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el index beca0bd00e2..8529d1dad5c 100644 --- a/lisp/emacs-lisp/package-vc.el +++ b/lisp/emacs-lisp/package-vc.el @@ -344,6 +344,33 @@ asynchronously." "\n") nil pkg-file nil 'silent)))) +(defcustom package-vc-process-make nil + "Whether to process :make and :shell-command spec arguments. + +When set to a list of symbols (packages), run commands for only +packages in the list. When `nil', never run commands. Otherwise +when non-`nil', run commands for any package with :make or +:shell-command specified. + +Package specs are loaded from trusted package archives." + :type '(choice (const :tag "Run for all packages" t) + (repeat :tag "Run only for selected packages" (symbol :tag "Package name")) + (const :tag "Never run" nil)) + :version "30.1") + +(defun package-vc--make (pkg-spec pkg-desc) + "Process :make and :shell-command PKG-SPEC arguments for PKG-DESC." + (let ((target (plist-get pkg-spec :make)) + (cmd (plist-get pkg-spec :shell-command))) + (when (or cmd target) + (with-current-buffer (get-buffer-create + (format " *package-vc make %s*" (package-desc-name pkg-desc))) + (erase-buffer) + (when (and cmd (/= 0 (call-process shell-file-name nil t nil shell-command-switch cmd))) + (warn "Failed to run %s, see buffer %S" cmd (buffer-name))) + (when (and target (/= 0 (apply #'call-process "make" nil t nil (if (consp target) target (list target))))) + (warn "Failed to make %s, see buffer %S" target (buffer-name))))))) + (declare-function org-export-to-file "ox" (backend file)) (defun package-vc--build-documentation (pkg-desc file) @@ -486,6 +513,16 @@ documentation and marking the package as installed." ;; Generate package file (package-vc--generate-description-file pkg-desc pkg-file) + ;; Process :make and :shell-command arguments before building documentation + (pcase package-vc-process-make + ((pred consp) ; When non-`nil' list, check if package is on the list. + (when (memq (package-desc-name pkg-desc) package-vc-process-make) + (package-vc--make pkg-spec pkg-desc))) + ('nil ; When `nil', do nothing. + nil) + (_ ; When otherwise non-`nil', run commands. + (package-vc--make pkg-spec pkg-desc))) + ;; Detect a manual (when (executable-find "install-info") (dolist (doc-file (ensure-list (plist-get pkg-spec :doc))) -- 2.40.1 --=-=-=--