From patchwork Tue Jan 9 22:47:33 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Tomas Volf <~@wolfsden.cz> X-Patchwork-Id: 58710 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 DDDC327BBE9; Tue, 9 Jan 2024 22:48:29 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_ADSP_ALL, DKIM_INVALID,DKIM_SIGNED,MAILING_LIST_MULTI,SPF_HELO_PASS, URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 5EF7827BBE2 for ; Tue, 9 Jan 2024 22:48:28 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rNKt4-0007FT-GL; Tue, 09 Jan 2024 17:47:58 -0500 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 1rNKt1-0007DJ-UW for guix-patches@gnu.org; Tue, 09 Jan 2024 17:47:55 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rNKt1-0004vd-LA for guix-patches@gnu.org; Tue, 09 Jan 2024 17:47:55 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rNKt8-0003As-N1 for guix-patches@gnu.org; Tue, 09 Jan 2024 17:48:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#68354] [PATCH 1/2] etc: snippets: Add skeletons for commit messages. Resent-From: Tomas Volf <~@wolfsden.cz> Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 09 Jan 2024 22:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68354 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 68354@debbugs.gnu.org Cc: Tomas Volf <~@wolfsden.cz> Received: via spool by 68354-submit@debbugs.gnu.org id=B68354.170484047012096 (code B ref 68354); Tue, 09 Jan 2024 22:48:02 +0000 Received: (at 68354) by debbugs.gnu.org; 9 Jan 2024 22:47:50 +0000 Received: from localhost ([127.0.0.1]:41237 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rNKsv-000390-AC for submit@debbugs.gnu.org; Tue, 09 Jan 2024 17:47:49 -0500 Received: from wolfsden.cz ([37.205.8.62]:50418) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from <~@wolfsden.cz>) id 1rNKss-00038V-Vd for 68354@debbugs.gnu.org; Tue, 09 Jan 2024 17:47:47 -0500 Received: by wolfsden.cz (Postfix, from userid 104) id 1692024D85B; Tue, 9 Jan 2024 22:47:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1704840459; bh=Rgjc60/6oZgU1kPW+ugi02OL676aRVaBkL6MGU7vba4=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=iyV9u7lKD82iYACKuUIZ0An8SlNnW7BgYMIY7LMOchw26fsZXYZgwosQ0SJ13Amh5 7kLKJCM5hAQWnQVoznVdtI0GYt1YMmFgFvieQPUzV9QXaJaRU+ndCP1bo0aVl8cXi7 yO14HfUDHMJF44TaMimsXPgcGyCoNXb+8h3jj51WGoDFv9BVLr6W95BUYOK6p7SYak ug2y2m7GUJsgBtsC/WTZgOqEQRv13+8LdAMrqZReAah1WHE7AE2oibMCGt0jnovPk6 vKrdcUmdgIB9JEwinWOZYB3wts0A8Cf2yZG0v2ll7ufyGn3/6G+aGLYZR7pCqeEQGr EmH1VIi6PNPDIGVDii4n1eP+xgJO29S3j3kSz3I7xRD6YXnBEMC8TX6wogq8paiUVj fmh0mvrZikTyzL7OjTKHr87TIPnUjgwtSiOZmztR/WV67Pv4jEZoyLDwsFIne1qHMX TcycUgayl2Y0khSw1+UiuVMBLI1kFP2pOhSjSVE+KAV2JWXU/l+m8srIZsAd6SHdOA aKDVHk3Ogg8dQwFqUgT78wuGX9C8kjir7ZuwaY9ZDV7Q77YIUPt/rkIXqYYqb3ulu6 GCf1rT8hwN0Np+UofzLxyYDUaO7zficGb3MxKpK4Py+GHMP3bm4b90ia+t177FEAa/ Yi90G6QBzXWvRh9cAlyTKFY8= Received: from localhost (unknown [146.70.134.143]) by wolfsden.cz (Postfix) with ESMTPSA id 1E47A24C45D; Tue, 9 Jan 2024 22:47:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1704840458; bh=Rgjc60/6oZgU1kPW+ugi02OL676aRVaBkL6MGU7vba4=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=NRZJO1d/YEdsmMfBwSkK9rfsPk3Y/tN71ZRQLINWHFnfm7PI0geZDpCETVMSdiQ08 rheK8CpV1oy7rbmIGZT3s5FsN8vOamUWAGxJ2wACAkaDEj+EBkERd4bNnw+W3UguE8 NpX24+cUBOkR3BIda5LA6+KOV+D3Iu1PnsqOyf9jgMFdFzSJp0wmBDOd18skFXiP4q hqTbsGHVTMSO5+qE/j34naVRE/+e7BxCymS4etAM3TWZaUzWEazdkDa8C/E7v902/R a0DVYhXngAFTDWaXTbFQaDOr0B/a51yQN/aqEm/1Kg8vCD0g/Agj5yvaag+LzcXRoD hF5hVJnnbkmaUnS2n/GfRaEUVOoKmUzZXWOLrE020+0xoSeUxJFa1BdTlTpdmGWYRI mLjymz7XQHtbHAcL0qZkslQ6iH4itcwYatdN9ZlyNiK8CG/+hyXKfXNH534iCwSTi+ Jt9H/+lgBRC0WXpvWDYH2jyqDnPol1DdoJp6y23k1E++KNNfiHmfxWwiPBMoDBCuCH cuqkUaIRUNqoZpO2X8ukQvn3N+JLc6FAcUn0nLDB7I6HU+HH++h4ATLFAuS0HpxLCn sXOhQHWuC2WaOJNb3bWPElHMqgkvBsZhMzn2h2Rk3Rg+TbkxNv3GVwcxaTR7k1rijs qQjwgOXglQ8QZLdyXm2SkMMs= From: Tomas Volf <~@wolfsden.cz> Date: Tue, 9 Jan 2024 23:47:33 +0100 Message-ID: <12887de50dc01339faf03aa66d298f1e16ec7b18.1704839576.git.~@wolfsden.cz> X-Mailer: git-send-email 2.41.0 In-Reply-To: References: MIME-Version: 1.0 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-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches Some people use just plain old skeleton system, which comes with Emacs. This commit adds skeletons for generating commit messages for the common operations (updating packages, ...). * etc/snippets/skeleton/commit-message.el: New file. * doc/contributing.texi (The Perfect Setup): Document it. Change-Id: Ic37b6455a337fc431ad2b049d5b7261da97e5a06 --- doc/contributing.texi | 20 ++++ etc/snippets/skeleton/commit-message.el | 143 ++++++++++++++++++++++++ 2 files changed, 163 insertions(+) create mode 100644 etc/snippets/skeleton/commit-message.el diff --git a/doc/contributing.texi b/doc/contributing.texi index 5707ff5cde..1311098dfc 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -360,6 +360,26 @@ The Perfect Setup @code{origin} snippet in turn may insert other trigger strings ending on @code{...}, which also can be expanded further. +@cindex skeleton +If you use built-in skeleton system (@xref{Top,,,autotype}), you can +load the snippets from the @file{etc/snippets/skeleton} directory. + +Skeletons for editing commit messages are provided in +@file{etc/snippets/skeleton/commit-message.el}. + +@cindex @code{M-x guix-package-add} +@cindex @code{M-x guix-package-remove} +@cindex @code{M-x guix-package-update} +@cindex @code{M-x guix-package-rename} +@cindex @code{M-x guix-package-move} +Once you load the file, the following functions are provided: +@code{guix-package-add}, @code{guix-package-remove}, +@code{guix-package-update}, @code{guix-package-rename} and +@code{guix-package-move}. When editing a commit message, invoke the +appropriate one using @code{M-x} to insert a message for the change. + +The commit message skeletons depend on @url{https://magit.vc/, Magit}. + @cindex insert or update copyright @cindex @code{M-x guix-copyright} @cindex @code{M-x copyright-update} diff --git a/etc/snippets/skeleton/commit-message.el b/etc/snippets/skeleton/commit-message.el new file mode 100644 index 0000000000..698079a004 --- /dev/null +++ b/etc/snippets/skeleton/commit-message.el @@ -0,0 +1,143 @@ +;;; commit-message.el --- skeletons for Guix's commit messages -*- lexical-binding: t; -*- +;;; Copyright © 2024 Tomas Volf <~@wolfsden.cz> + +;; Author: Tomas Volf <~@wolfsden.cz> +;; Keywords: vc, convenience + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Code: + +(defun guix--package-name-from-magit-diff (regex) + (with-temp-buffer + (magit-git-wash #'magit-diff-wash-diffs "diff" "--cached") + (goto-char (point-min)) + (when (re-search-forward regex + nil 'noerror) + (match-string-no-properties 1)))) + +(defun guix--first-file-from-magit-diff () + (car (magit-staged-files))) + +(define-skeleton guix-package-add + "Insert a commit message for adding a package." + nil + '(setq v1 (or (guix--package-name-from-magit-diff + (rx "+(define-public " (group (+ (not (syntax whitespace)))))) + (skeleton-read "Package: "))) + '(setq v2 (or (guix--first-file-from-magit-diff) + (skeleton-read "File: "))) + ;; v1 - package, v2 - file + "gnu: Add " v1 "." \n + _ \n + "* " v2 " (" v1 "): New variable." \n) + +(define-skeleton guix-package-remove + "Insert a commit message for removing a package." + nil + '(setq v1 (or (guix--package-name-from-magit-diff + (rx "-(define-public " (group (+ (not (syntax whitespace)))))) + (skeleton-read "Package: "))) + '(setq v2 (or (guix--first-file-from-magit-diff) + (skeleton-read "File: "))) + ;; v1 - package, v2 - file + "gnu: Remove " v1 "." \n + _ \n + "* " v2 " (" v1 "): Delete variable." \n) + +(define-skeleton guix-package-update + "Insert a commit message for updating a package." + (or (guix--package-name-from-magit-diff + (rx line-start (* (syntax whitespace)) + "(define-public " (group (+ (not (syntax whitespace)))))) + (skeleton-read "Package: ")) + '(setq v1 (or (with-temp-buffer + (magit-git-wash #'magit-diff-wash-diffs + "diff" "--cached") + (goto-char (point-min)) + (search-forward "name" nil 'noerror) + (search-forward "+" nil 'noerror) ; first change + (when (and (search-forward "version " nil 'noerror) + (looking-at-p "\"")) + (let ((end (save-excursion (search-forward "\")" + nil 'noerror)))) + (when end + (forward-char) + (buffer-substring-no-properties (point) (- end 2)))))) + (skeleton-read "New version: "))) + '(setq v2 (or (guix--first-file-from-magit-diff) + (skeleton-read "File: "))) + ;; str - package, v1 - new version, v2 - file + "gnu: " str ": Update to " v1 "." \n + _ \n + "* " v2 " (" str "): Update to " v1 "." \n) + +(define-skeleton guix-package-rename + "Insert a commit message for renaming a package." + (or (guix--first-file-from-magit-diff) + (skeleton-read "File: ")) + '(setq v1 (or (guix--package-name-from-magit-diff + (rx "-(define-public " (group (+ (not (syntax whitespace)))))) + (skeleton-read "Old package: "))) + '(setq v2 (or (guix--package-name-from-magit-diff + (rx "+(define-public " (group (+ (not (syntax whitespace)))))) + (skeleton-read "New package: "))) + ;; str - file, v1 - old package, v2 - new package + "gnu: " v1 ": Rename package to " v2 "." \n + _ \n + @ + "* " str " (" v1 "): Define in terms of `deprecated-package'." \n + "(" v2 "): New variable, formerly known as `crawl'." \n + @ + '(fill-region (cadr skeleton-positions) (car skeleton-positions))) + +(define-skeleton guix-package-move + "Insert a commit message for moving a package." + (or (guix--package-name-from-magit-diff + (rx "-(define-public " (group (+ (not (syntax whitespace)))))) + (skeleton-read "Package: ")) + '(setq v1 (or (with-temp-buffer + (magit-git-wash #'magit-diff-wash-diffs + "diff" "--cached" "--no-prefix") + (goto-char (point-min)) + (when (and + (re-search-forward "\\-(define-public \\(\\S-+\\)" + nil 'noerror) + (re-search-backward "modified[ ]*\\(\\S-+\\)" + nil 'noerror)) + (match-string-no-properties 1))) + (skeleton-read "Old file: "))) + '(setq v2 (or (with-temp-buffer + (magit-git-wash #'magit-diff-wash-diffs + "diff" "--cached" "--no-prefix") + (goto-char (point-min)) + (when (and + (re-search-forward "\\+(define-public \\(\\S-+\\)" + nil 'noerror) + (re-search-backward "modified[ ]*\\(\\S-+\\)" + nil 'noerror)) + (match-string-no-properties 1))) + (skeleton-read "New file: "))) + ;; str - package, v1 - old file, v2 - new file + "gnu: " str ": Move to (" + (string-replace ".scm" "" (string-replace "/" " " v2)) + ")." \n + _ \n + @ + "* " v1 " (" str "): Move from here..." \n + "* " v2 " (" str "): ...to here." \n + @ + '(fill-region (cadr skeleton-positions) (car skeleton-positions))) + +;;; commit-message.el ends here From patchwork Tue Jan 9 22:47:34 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tomas Volf <~@wolfsden.cz> X-Patchwork-Id: 58711 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 C93C727BBE9; Tue, 9 Jan 2024 22:48:33 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_ADSP_ALL, DKIM_INVALID,DKIM_SIGNED,MAILING_LIST_MULTI,SPF_HELO_PASS, URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id AEF7227BBE2 for ; Tue, 9 Jan 2024 22:48:32 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rNKt7-0007G3-JU; Tue, 09 Jan 2024 17:48:01 -0500 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 1rNKt2-0007DZ-An for guix-patches@gnu.org; Tue, 09 Jan 2024 17:47:57 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rNKt2-0004w7-2D for guix-patches@gnu.org; Tue, 09 Jan 2024 17:47:56 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rNKt9-0003B1-3H for guix-patches@gnu.org; Tue, 09 Jan 2024 17:48:03 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#68354] [PATCH 2/2] etc: snippets: Add skeletons for scheme-mode. Resent-From: Tomas Volf <~@wolfsden.cz> Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 09 Jan 2024 22:48:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68354 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 68354@debbugs.gnu.org Cc: Tomas Volf <~@wolfsden.cz> Received: via spool by 68354-submit@debbugs.gnu.org id=B68354.170484047212119 (code B ref 68354); Tue, 09 Jan 2024 22:48:03 +0000 Received: (at 68354) by debbugs.gnu.org; 9 Jan 2024 22:47:52 +0000 Received: from localhost ([127.0.0.1]:41239 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rNKsx-00039L-Vj for submit@debbugs.gnu.org; Tue, 09 Jan 2024 17:47:52 -0500 Received: from wolfsden.cz ([37.205.8.62]:50432) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from <~@wolfsden.cz>) id 1rNKsu-00038f-1E for 68354@debbugs.gnu.org; Tue, 09 Jan 2024 17:47:48 -0500 Received: by wolfsden.cz (Postfix, from userid 104) id 5506E24E290; Tue, 9 Jan 2024 22:47:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1704840460; bh=7cKR1h15n1lkP+41ZrInoCaa71hPXBoan4B8K5dASCo=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=HZD/jqpA4qvjvm4qtTtCBwVqDUnBTm5xSvCHKIvy9pz+Eo/recYetZh0kM6L2ER2R s784hynHabxZ7AqVuYyNUi4y/2J++MAoxH/6vY86OeedhW8DG0y8GcF2Zb3v4xjJkA mP83+FkytW4jQwdmUR0afhuevDvH/szln74YnFA3JYFL/de8oL3Ah5/l06nUbwF19J DNl5ZxvibAGPZfEyvhJmt2H92kTVaJkAsX9XgG4Bv4CWgjSjla1rmttzx+y0ICKYZS yOQCMwYgp6FFyqrIyEOxA6QQXG2MXGKJaJmcpphhYF/DRa6jrCdvw2/eoKU29OXtlT Ax3J/q5h8YgayZYv6GxkdJRuMPq93lMOmWa2WCdYxsVE2h5qlbKuXHUInR8b8fDuzb a8zwn2oz8xBHTVKrWlRGT4t2tPTvR28R8jHdgavarPQ4usnT1vuc15RaYyn8axsaQ1 vj5ueCJVNmzoQB1TpKicjrHLtORrrNmHEd2kZCsuwpMbYUBQHCABYuwzNVv+TP2F/K Y0CRLdtfUqHKnz9tElL7OUlMDzFA4eaSZFlN5e+Ac29jUMA77/rY7JSv0UjtSugW31 WO/eWN05Owj3/pXzP91S0bE2FfgbVrHQnZyl0LipdMpKHl0xt1Lsvk00Wy6BgGABk9 TpHajpT70IBplwaKNnfg+l54= Received: from localhost (unknown [146.70.134.143]) by wolfsden.cz (Postfix) with ESMTPSA id CB16C24D85C; Tue, 9 Jan 2024 22:47:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1704840459; bh=7cKR1h15n1lkP+41ZrInoCaa71hPXBoan4B8K5dASCo=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=oc6nUytFtKNL303xGD29aOTK7iZWK2LT01j1d9/KRJu/M8hWNb4mHm6Zi4Z1C34XH btTX3chGnX6OuhFsMqkTt7bstqISZ5cwV42Rz3GjVfgYuh/7g4dJj6P5w97lnaElbL SDAbHyo0VRiAe8p7JwKfDRIfheArIHG9IH3V/6QgLrg7b41dp6f63HcdUqlSZIIdqB TSIRH6zI1JBORgJDunXOwd7ipVSpdaCFx0GHEQ376ZpE/QWe4WAPxyicMtDL1CSe54 M4ejpAJaYwnEciexZB64rtWxc5vdimvzRoZO67OL+DW6pEZ/esDB3vlSuKaDsG7ZOF LwHjhPqAzkwt/Y3WWTJmdyQjwhxtlbCkcrMzUcwbeEshnE2yuGRAfBnQI2zGw0WrUz pqA0YwbMQCTBoyOBgzJwI++LOn1eVn3bohrYeeT2BzuerNCimy0wQWe8U0sV5D4KBn /95YdI5nkx98OvC7l9bjiXqrFoXTnHv9HM2n097Cou7SE+lk3wboMeKYiOhO+0ovSY I/Rn6EiUtUxFw+8uzlw/ychGSBCILooSY7UADxA3pflg8zjfgmJIRzaBJ4h55Nzffv HoIBa5f+bjh7Djxg2OD0B7JNDQpqhXrLazjvjZLb5In71PEoh+ac+RlTVBrTVrBqAL GVM47wSeef0vfbwit2LxYKZo= From: Tomas Volf <~@wolfsden.cz> Date: Tue, 9 Jan 2024 23:47:34 +0100 Message-ID: <02b255ba2b890b842e7f6e42fa5a4c56efce6062.1704839576.git.~@wolfsden.cz> X-Mailer: git-send-email 2.41.0 In-Reply-To: References: MIME-Version: 1.0 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-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches Some people use just plain old skeleton system, which comes with Emacs. This commit adds skeletons for generating package definition and some other common parts. * etc/snippets/skeleton/scheme.el: New file. * doc/contributing.texi (The Perfect Setup): Document it. Change-Id: Ided31c06266b0d3c70ae1e050ae8694fd5e47751 --- doc/contributing.texi | 22 ++++++ etc/snippets/skeleton/scheme.el | 117 ++++++++++++++++++++++++++++++++ 2 files changed, 139 insertions(+) create mode 100644 etc/snippets/skeleton/scheme.el diff --git a/doc/contributing.texi b/doc/contributing.texi index 1311098dfc..b5ee046c0a 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -380,6 +380,28 @@ The Perfect Setup The commit message skeletons depend on @url{https://magit.vc/, Magit}. +Additional skeletons for editing the package definitions are provided in +@file{etc/snippets/skeleton/scheme.el}. + +@cindex @code{M-x guix-insert-package} +@cindex @code{M-x guix-insert-origin} +@cindex @code{M-x guix-insert-git-reference} +@cindex @code{M-x guix-insert-hg-reference} +@cindex @code{M-x guix-insert-svn-reference} +@cindex @code{M-x guix-insert-bzr-reference} +@cindex @code{M-x guix-insert-cvs-reference} +@cindex @code{M-x guix-insert-:phases} +Once you load the file, the following functions are provided: +@code{guix-insert-package}, @code{guix-insert-origin}, +@code{guix-insert-git-reference}, @code{guix-insert-hg-reference}, +@code{guix-insert-svn-reference}, @code{guix-insert-bzr-reference}, +@code{guix-insert-cvs-reference} and @code{guix-insert-:phases}. They +do what you would expect based on the name, inserting the implied +snippet while asking for data to fill in. @code{guix-insert-:phases} +inserts commonly used snippet to edit phases for the package. + +The scheme skeletons might depend on paredit for correct indentation. + @cindex insert or update copyright @cindex @code{M-x guix-copyright} @cindex @code{M-x copyright-update} diff --git a/etc/snippets/skeleton/scheme.el b/etc/snippets/skeleton/scheme.el new file mode 100644 index 0000000000..6114b2ffbf --- /dev/null +++ b/etc/snippets/skeleton/scheme.el @@ -0,0 +1,117 @@ +;;; scheme.el --- skeletons for scheme-mode -*- lexical-binding: t; -*- + +;; Copyright (C) 2024 Tomas Volf + +;; Author: Tomas Volf <~@wolfsden.cz> +;; Keywords: convenience + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Code: + +(define-skeleton guix-insert-package + "Insert a Guix package definition." + "Name: " + "(define-public " str + \n"(package" + \n "(name \"" str "\")" + \n "(version \"" (skeleton-read "Version: ") "\")" + \n "(source " _ ")" + \n "(build-system " (skeleton-read "Build system: " "gnu") "-build-system)" + \n "(home-page \"" (skeleton-read "Homepage: ") "\")" + \n "(synopsis " (format "%S" (skeleton-read "Synopsis: ")) ")" + \n "(description " (format "%S" (skeleton-read "Description: ")) ")" + \n "(license license:" (skeleton-read "License: " "unknown") ")))" + \n) + +(define-skeleton guix-insert-origin + "Insert a Guix origin definition." + nil + '(setq v1 (skeleton-read "Method: " "url")) + '(setq v1 (if (string-search "-fetch" v1) + v1 + (concat v1 "-fetch"))) + "(origin" + \n"(method " v1 ")" + \n"(uri " (let ((skeleton-end-newline nil)) + (pcase v1 + ((or "git-fetch" "git-fetch/lfs") + (guix-insert-git-reference)) + ("hg-fetch" + (guix-insert-hg-reference)) + ("svn-fetch" + (guix-insert-svn-reference)) + ("bzr-fetch" + (guix-insert-bzr-reference)) + ("cvs-fetch" + (guix-insert-cvs-reference)) + ("url-fetch" + (insert (format "%S" (skeleton-read "URI: "))))) + nil) + ")" + \n (pcase v1 + ((or "git-fetch" "git-fetch/lfs") + "(file-name (git-file-name name version))") + ("hg-fetch" + "(file-name (hg-file-name name version))") + ((or "svn-fetch" "bzr-fetch" "cvs-fetch") + "(file-name (string-append name \"-\" version \"-checkout\"))")) + & \n"(sha256" + \n "(base32 " + ;; Hash of an empty directory + \n (format "%S" "0sjjj9z1dhilhpc8pq4154czrb79z9cm044jvn75kxcjv6v5l2m5") ")))") + +(define-skeleton guix-insert-git-reference + "Insert a Guix git-reference definition." + nil + "(git-reference" + \n"(url \"" (skeleton-read "URL: ") "\")" + \n"(commit \"" (skeleton-read "Commit / Tag: ") "\"))") + +(define-skeleton guix-insert-hg-reference + "Insert a Guix hg-reference definition." + nil + "(hg-reference" + \n"(url \"" (skeleton-read "URL: ") "\")" + \n"(changeset \"" (skeleton-read "Changeset: ") "\"))") + +(define-skeleton guix-insert-svn-reference + "Insert a Guix svn-reference definition." + nil + "(svn-reference" + \n"(url \"" (skeleton-read "URL: ") "\")" + \n"(revision \"" (skeleton-read "Revision: ") "\"))") + +(define-skeleton guix-insert-bzr-reference + "Insert a Guix bzr-reference definition." + nil + "(bzr-reference" + \n"(url \"" (skeleton-read "URL: ") "\")" + \n"(revision \"" (skeleton-read "Revision: ") "\"))") + +(define-skeleton guix-insert-cvs-reference + "Insert a Guix cvs-reference definition." + nil + "(cvs-reference" + \n"(root-directory \"" (skeleton-read "Root directory: ") "\")" + \n"(module \"" (skeleton-read "Module: ") "\")" + \n"(revision \"" (skeleton-read "Revision: ") "\"))") + +(define-skeleton guix-insert-:phases + "Insert a Guix #:phases snippet." + nil + "#:phases " \n + "(modify-phases %standard-phases" \n + _ ")") +;;; scheme.el ends here