From patchwork Fri Sep 3 04:06:26 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Sarah Morgensen X-Patchwork-Id: 32533 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 0455B27BBE3; Fri, 3 Sep 2021 05:07:29 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,T_DKIM_INVALID, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 5DD4527BBE1 for ; Fri, 3 Sep 2021 05:07:28 +0100 (BST) Received: from localhost ([::1]:49904 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mM0UB-0003gX-Gv for patchwork@mira.cbaines.net; Fri, 03 Sep 2021 00:07:27 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:48384) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mM0Tn-0003fz-3y for guix-patches@gnu.org; Fri, 03 Sep 2021 00:07:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:59198) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mM0Tm-0004w7-So for guix-patches@gnu.org; Fri, 03 Sep 2021 00:07:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mM0Tm-00036w-Jm for guix-patches@gnu.org; Fri, 03 Sep 2021 00:07:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#50349] [PATCH] packages: Add 'define-package' syntax. Resent-From: Sarah Morgensen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Fri, 03 Sep 2021 04:07:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 50349 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 50349@debbugs.gnu.org X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.163064199811924 (code B ref -1); Fri, 03 Sep 2021 04:07:02 +0000 Received: (at submit) by debbugs.gnu.org; 3 Sep 2021 04:06:38 +0000 Received: from localhost ([127.0.0.1]:42511 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mM0TO-00036F-3u for submit@debbugs.gnu.org; Fri, 03 Sep 2021 00:06:38 -0400 Received: from lists.gnu.org ([209.51.188.17]:53296) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mM0TM-000367-LI for submit@debbugs.gnu.org; Fri, 03 Sep 2021 00:06:37 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:48324) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mM0TL-0003eL-LS for guix-patches@gnu.org; Fri, 03 Sep 2021 00:06:36 -0400 Received: from out0.migadu.com ([94.23.1.103]:39653) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mM0TI-0004Sp-0E for guix-patches@gnu.org; Fri, 03 Sep 2021 00:06:35 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mgsn.dev; s=key1; t=1630641989; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=CvJCpfvD/KAVUiSNJ0d1E4N2r9otbKVcqE68XxN2hCE=; b=SzB2uPCwny/d2VdiLyh/9NcRDpaRJBrm1vnYGnJBRUoiaVoss3qb6RZ3/L+KwateHJpr1V PvP+Vh3DMBqyCnkVnzSYT4Amyk04iUFXOPEBmsrGGEgz3St+hMaBnNbZ2Y6rNd5+sHzgyf 90XUBQjh7CD/W9NhQ0qysIvFDBrGeAA= From: Sarah Morgensen Date: Thu, 2 Sep 2021 21:06:26 -0700 Message-Id: <15d01b32313f5f2f291b120597719ae92bd26acd.1630639896.git.iskarian@mgsn.dev> MIME-Version: 1.0 X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: iskarian@mgsn.dev Received-SPF: pass client-ip=94.23.1.103; envelope-from=iskarian@mgsn.dev; helo=out0.migadu.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * guix/packages.scm (define-package): New syntax. * .dir-locals.el: Add indent rule for 'define-package'. * etc/indent-code.el (main): Adjust package search regex accordingly. * etc/snippets/text-mode/guix-commit-message-add-cl-package: Likewise. * etc/snippets/text-mode/guix-commit-message-add-package: Likewise. * etc/snippets/text-mode/guix-commit-message-rename-package: Likewise. * etc/snippets/text-mode/guix-commit-message-update-package: Likewise. --- Hello Guix, This patch adds a shorthand for "(define-public name (package ...))": (define-package my-favorite-package (name "my-favorite-package") ...) The purpose is primarily to save the horizontal indent, but IMO it looks better, and is marginally more clear for newcomers. I think ideally we could eventually transition to using this syntax as the primary syntax and only use 'define-public' when necessary. There are some downsides... it's one more form to keep track of, and 'let' forms can't easily be used with it. Since it's a syntax rule, it doesn't cause packages to rebuild (tested). I've also tested the indentation rules, indent-code.el, and the snippets. This probably deserves a documentation addition, but I wasn't sure where to add it without confusing newcomers. Suggestions welcome! (If this is accepted, we'll also want to make a few changes to emacs-guix/elisp/guix-devel.el, adding 'define-package' to 'guix-devel-keywords' and to 'guix-devel-scheme-indent' with level 1.) What do you all think? -- Sarah .dir-locals.el | 1 + etc/indent-code.el | 2 +- etc/snippets/text-mode/guix-commit-message-add-cl-package | 2 +- etc/snippets/text-mode/guix-commit-message-add-package | 2 +- etc/snippets/text-mode/guix-commit-message-rename-package | 4 ++-- etc/snippets/text-mode/guix-commit-message-update-package | 2 +- guix/packages.scm | 8 ++++++++ 7 files changed, 15 insertions(+), 6 deletions(-) base-commit: 95c29d2746943733cbe8df7013854d45bb0df413 diff --git a/.dir-locals.el b/.dir-locals.el index aaa48ab552..8141cf4fc2 100644 --- a/.dir-locals.el +++ b/.dir-locals.el @@ -71,6 +71,7 @@ (eval . (put 'with-writable-file 'scheme-indent-function 2)) (eval . (put 'package 'scheme-indent-function 0)) + (eval . (put 'define-package 'scheme-indent-function 1)) (eval . (put 'package/inherit 'scheme-indent-function 1)) (eval . (put 'origin 'scheme-indent-function 0)) (eval . (put 'build-system 'scheme-indent-function 0)) diff --git a/etc/indent-code.el b/etc/indent-code.el index bdea8ee8bf..b83659f2f9 100755 --- a/etc/indent-code.el +++ b/etc/indent-code.el @@ -94,7 +94,7 @@ ;; Indent the definition of PACKAGE-NAME in FILE-NAME. (find-file file-name) (goto-char (point-min)) - (if (re-search-forward (concat "^(define\\(\\|-public\\) +" + (if (re-search-forward (concat "^(define\\(\\|-public\\|-package\\) +" package-name) nil t) (let ((indent-tabs-mode nil)) diff --git a/etc/snippets/text-mode/guix-commit-message-add-cl-package b/etc/snippets/text-mode/guix-commit-message-add-cl-package index e255736b05..eb0de677e7 100644 --- a/etc/snippets/text-mode/guix-commit-message-add-cl-package +++ b/etc/snippets/text-mode/guix-commit-message-add-cl-package @@ -7,7 +7,7 @@ gnu: Add ${1:`(with-temp-buffer (magit-git-wash #'magit-diff-wash-diffs "diff" "--staged") (beginning-of-buffer) - (when (search-forward "+(define-public " nil 'noerror) + (when (re-search-forward "+(define-\\(public\\|package\\) " nil 'noerror) (replace-regexp-in-string "^sbcl-" "" (thing-at-point 'sexp 'no-properties))))`}. diff --git a/etc/snippets/text-mode/guix-commit-message-add-package b/etc/snippets/text-mode/guix-commit-message-add-package index 7cebd4023a..11aeceb129 100644 --- a/etc/snippets/text-mode/guix-commit-message-add-package +++ b/etc/snippets/text-mode/guix-commit-message-add-package @@ -7,7 +7,7 @@ gnu: Add ${1:`(with-temp-buffer (magit-git-wash #'magit-diff-wash-diffs "diff" "--staged") (goto-char (point-min)) - (when (re-search-forward "\\+(define-public \\(\\S-+\\)" nil 'noerror) + (when (re-search-forward "\\+(define-\\(?:public\\|package\\) \\(\\S-+\\)" nil 'noerror) (match-string-no-properties 1)))`}. * `(car (magit-staged-files))` ($1): New variable. \ No newline at end of file diff --git a/etc/snippets/text-mode/guix-commit-message-rename-package b/etc/snippets/text-mode/guix-commit-message-rename-package index 9695ca1b3d..2315443573 100644 --- a/etc/snippets/text-mode/guix-commit-message-rename-package +++ b/etc/snippets/text-mode/guix-commit-message-rename-package @@ -7,12 +7,12 @@ gnu: ${1:`(with-temp-buffer (magit-git-wash #'magit-diff-wash-diffs "diff" "--staged") (beginning-of-buffer) - (when (search-forward "-(define-public " nil 'noerror) + (when (re-search-forward "-(define-\\(public\\|package\\) " nil 'noerror) (thing-at-point 'sexp 'no-properties)))`}: Rename package to ${2:`(with-temp-buffer (magit-git-wash #'magit-diff-wash-diffs "diff" "--staged") (beginning-of-buffer) - (when (search-forward "+(define-public " nil 'noerror) + (when (re-search-forward "+(define-\\(public\\|package\\) " nil 'noerror) (thing-at-point 'sexp 'no-properties)))`}. * `(car (magit-staged-files))` ($1): Define in terms of diff --git a/etc/snippets/text-mode/guix-commit-message-update-package b/etc/snippets/text-mode/guix-commit-message-update-package index f187419aa2..1d39e28b77 100644 --- a/etc/snippets/text-mode/guix-commit-message-update-package +++ b/etc/snippets/text-mode/guix-commit-message-update-package @@ -8,7 +8,7 @@ gnu: ${1:`(with-temp-buffer (magit-git-wash #'magit-diff-wash-diffs "diff" "--staged") (goto-char (point-min)) - (when (re-search-forward "(define-public \\(\\S-+\\)" nil 'noerror) + (when (re-search-forward "(define-\\(?:public\\|package\\) \\(\\S-+\\)" nil 'noerror) (match-string-no-properties 1)))`}: Update to ${2:`(with-temp-buffer (magit-git-wash #'magit-diff-wash-diffs "diff" "--staged") diff --git a/guix/packages.scm b/guix/packages.scm index c825f427d8..ecd0b7e47d 100644 --- a/guix/packages.scm +++ b/guix/packages.scm @@ -6,6 +6,7 @@ ;;; Copyright © 2017, 2019, 2020 Efraim Flashner ;;; Copyright © 2019 Marius Bakke ;;; Copyright © 2021 Chris Marusich +;;; Copyright © 2021 Sarah Morgensen ;;; ;;; This file is part of GNU Guix. ;;; @@ -99,6 +100,7 @@ (define-module (guix packages) package-supported-systems package-properties package-location + define-package hidden-package hidden-package? package-superseded @@ -425,6 +427,12 @@ (define-record-type* package) 16))))) +(define-syntax-rule (define-package name body ...) + "Equivalent to (define-public name (package body ...))." + (define-public name + (package + body ...))) + (define-syntax-rule (package/inherit p overrides ...) "Like (package (inherit P) OVERRIDES ...), except that the same transformation is done to the package P's replacement, if any. P must be a bare