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: Sun, 07 May 2023 11:47:29 -0700 Message-ID: <87pm7b7up0.fsf@breatheoutbreathe.in> References: <874joprxmx.fsf@breatheoutbreathe.in> <87jzxkecnk.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="31051"; 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 Sun May 07 22:29: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 1pvl0Z-0007rT-I2 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 07 May 2023 22:29:28 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pvl0C-000224-TZ; Sun, 07 May 2023 16:29:04 -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 1pvl0A-00021g-Nk for bug-gnu-emacs@gnu.org; Sun, 07 May 2023 16:29:02 -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 1pvl0A-0008JS-Ek for bug-gnu-emacs@gnu.org; Sun, 07 May 2023 16:29:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pvl0A-000381-9u for bug-gnu-emacs@gnu.org; Sun, 07 May 2023 16:29:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Joseph Turner Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 07 May 2023 20:29:02 +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.168349129811966 (code B ref 63336); Sun, 07 May 2023 20:29:02 +0000 Original-Received: (at 63336) by debbugs.gnu.org; 7 May 2023 20:28:18 +0000 Original-Received: from localhost ([127.0.0.1]:38575 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pvkzS-00036v-7K for submit@debbugs.gnu.org; Sun, 07 May 2023 16:28:18 -0400 Original-Received: from out-49.mta0.migadu.com ([91.218.175.49]:35691) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pvkzQ-00036j-7G for 63336@debbugs.gnu.org; Sun, 07 May 2023 16:28:17 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=breatheoutbreathe.in; s=key1; t=1683491294; 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=Xty4WvFOuwgr9v3ejeDiR+VJrVWRSqPS25pWtUI7YSs=; b=TBZw87a3ISoS15AaBimb0wy3i6NEfmhSiXfCYr5Pk6OwwIQAmrdMaBFYxxgDBJZWsNowz1 A9V0rY9Ofmd1Tqx4IoXaHJBwYFzyFHg3D6u4jAIQ0pMdXFcgk0Kv2wHa6mnAZZdxM8QUWk ghwYPNvMGip7gl6aCpiL2smAo9RptfU= X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <87jzxkecnk.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:261277 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Thanks for the review! Philip Kaludercic writes: > Joseph Turner writes: > >> Hello! >> >> Here's a patch to support :make and :shell-command args as discussed: >> >> https://lists.gnu.org/archive/html/help-gnu-emacs/2023-04/msg00263.html > > Thanks! > >> Best, >> >> Joseph >> >> From c51161c51f11e6ffcba17758424596fe44f9d42a Mon Sep 17 00:00:00 2001 >> From: Joseph Turner >> Date: Sat, 6 May 2023 13:44:32 -0700 >> Subject: [PATCH] package-vc: Process :make and :shell-command spec args >> >> --- >> lisp/emacs-lisp/package-vc.el | 32 ++++++++++++++++++++++++++++++++ >> 1 file changed, 32 insertions(+) >> >> diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.= el >> index 421947b528d..489610e2a1e 100644 >> --- a/lisp/emacs-lisp/package-vc.el >> +++ b/lisp/emacs-lisp/package-vc.el >> @@ -344,6 +344,35 @@ asynchronously." >> "\n") >> nil pkg-file nil 'silent)))) >> >> +(defcustom package-vc-process-make nil >> + "If non-nil, process :make and :shell-command spec arguments. >> +Package specs are loaded from trusted package archives." >> + :type 'boolean) > > As this patch is going to be added to Emacs 30, we should add > > :version "30.1" > > tags to this user option. Fixed. >> +(defun package-vc--call (destination program &rest args) >> + "Like =E2=80=98call-process=E2=80=99 for PROGRAM, DESTINATION, ARGS. > ^ > You should replace these quotation marks with regular ASCII `marks', so > avoid byte-compiler warnings. Good catch. >> +The INFILE and DISPLAY arguments are fixed as nil." >> + (apply #'call-process program nil destination nil (delq nil args))) > > What is the motivation for this function? Is this where > process-isolation would be added in the future? In the attached patch, package-vc--call is replaced with call-process. >> +(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? For comparison, package-vc--build-documentation creates a buffer called " *package-vc doc*" without the package name. >> + (erase-buffer) >> + (when (and cmd >> + (/=3D 0 (package-vc--call t shell-file-name >> + shell-command-switch >> + cmd))) >> + (message "Failed to run %s, see buffer %S" > > Could `warn' be a better candidate here, instead of `message'? Done. >> + cmd (buffer-name))) >> + (when (and target >> + (/=3D 0 (apply #'package-vc--call t "make" >> + (if (consp target) target (list target)= )))) >> + (message "Failed to make %s, see buffer %S" And this message is changed to warn also. >> + 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 doc= umentation >> + (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. >> + >> ;; 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? Best, Joseph --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-package-vc-Process-make-and-shell-command-spec-args.patch >From f536b42492e1520cc8da4e92b5bb65552ba39e6a Mon Sep 17 00:00:00 2001 From: Joseph Turner Date: Sat, 6 May 2023 13:44:32 -0700 Subject: [PATCH] package-vc: Process :make and :shell-command spec args --- lisp/emacs-lisp/package-vc.el | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el index 421947b528d..476c38916a8 100644 --- a/lisp/emacs-lisp/package-vc.el +++ b/lisp/emacs-lisp/package-vc.el @@ -344,6 +344,31 @@ 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 (boolean :tag "Run for all packages") + (repeat (symbol :tag "Run for only selected packages"))) + :version "30.1") + +(defun package-vc--make (pkg-spec) + "Process :make and :shell-command PKG-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*") + (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 +511,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))) + ('nil ; When `nil', do nothing. + nil) + (_ ; When otherwise non-`nil', run commands. + (package-vc--make pkg-spec))) + ;; Detect a manual (when (executable-find "install-info") (dolist (doc-file (ensure-list (plist-get pkg-spec :doc))) -- 2.39.2 --=-=-=--