From patchwork Thu Mar 30 22:29:24 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Antero Mejr X-Patchwork-Id: 48833 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 7876817201; Thu, 30 Mar 2023 23:30:23 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-1.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable 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 E18E81705B for ; Thu, 30 Mar 2023 23:30:21 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pi0mU-0005ru-0d; Thu, 30 Mar 2023 18:30:06 -0400 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 1pi0mS-0005rh-4D for guix-patches@gnu.org; Thu, 30 Mar 2023 18:30:04 -0400 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 1pi0mR-0001Tw-Jf for guix-patches@gnu.org; Thu, 30 Mar 2023 18:30:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pi0mR-00023H-9M for guix-patches@gnu.org; Thu, 30 Mar 2023 18:30:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#59318] [PATCH v3] etc: committer: Add --package-directory and --help flags. References: <20221116185853.13957-1-antero@mailbox.org> In-Reply-To: <20221116185853.13957-1-antero@mailbox.org> Resent-From: Antero Mejr Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 30 Mar 2023 22:30:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59318 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch moreinfo To: 59318@debbugs.gnu.org Cc: liliana.prikler@gmail.com, maxim.cournoyer@gmail.com Received: via spool by 59318-submit@debbugs.gnu.org id=B59318.16802153817821 (code B ref 59318); Thu, 30 Mar 2023 22:30:03 +0000 Received: (at 59318) by debbugs.gnu.org; 30 Mar 2023 22:29:41 +0000 Received: from localhost ([127.0.0.1]:59685 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pi0m4-000224-KW for submit@debbugs.gnu.org; Thu, 30 Mar 2023 18:29:41 -0400 Received: from mout-p-102.mailbox.org ([80.241.56.152]:55596) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pi0m2-00021m-Hx for 59318@debbugs.gnu.org; Thu, 30 Mar 2023 18:29:39 -0400 Received: from smtp2.mailbox.org (smtp2.mailbox.org [IPv6:2001:67c:2050:b231:465::2]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-102.mailbox.org (Postfix) with ESMTPS id 4PndQ24FpGz9sk8; Fri, 31 Mar 2023 00:29:30 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mailbox.org; s=mail20150812; t=1680215370; 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: content-transfer-encoding:content-transfer-encoding; bh=oGhQGWlAAjHlsxrkgmGFLQlIzUzsrZbVHkh6uI920iw=; b=ryi9NQ4iwZoD5YCZvc6DBuXSG2PxiBl6qn4OYf8bp9l6ZmO+QHM4/4uWgE7l3Dcq/Jeoob R72ishu/b4M14hHl2W7Yxco1VYyf3cReuJldofXiX8uldrvFCtQAkz1viivo47bDcFqywD mwXGSldEYYS9gp9EFXGgghW3iYFUTWkLWM3lzS8wv+up0Gjb55XKQNpEemWQt/ffgIf7Xr GHhrv4JY0b4zK1Nde8Ac5yj/Et9N3W2ieegd8imUyENXDLN9rSIRXnbL1HEYvx345whIKI LvCFDk1Y4oWoSlj0SXvIz6k7nFsJEKPzepPWQHbrEkI8rmzXyfRFwYoGNVSqyw== Date: Thu, 30 Mar 2023 22:29:24 +0000 Message-Id: <20230330222924.11606-1-antero@mailbox.org> MIME-Version: 1.0 X-MBO-RS-META: ok5madbp6nac4imm66q1y4cek145h95d X-MBO-RS-ID: a42873492ed72a6b6c9 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: , Reply-to: Antero Mejr X-ACL-Warn: , Antero Mejr via Guix-patches X-Patchwork-Original-From: Antero Mejr via Guix-patches via From: Antero Mejr 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 * etc/committer.scm.in (prepend-package-dir, show-help): New procedures. (change-commit-message, add-commit-message, remove-commit-message, custom-commit-message): Use prepend-package-dir. (diff-info): Use the %package-dir parameter. (main): Use SRFI-37 argument parser. --- v3: use/document the MESSAGE and CHANGELOG arguments and update wording. etc/committer.scm.in | 67 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 59 insertions(+), 8 deletions(-) diff --git a/etc/committer.scm.in b/etc/committer.scm.in index e7f1ca8c45..dbc979a6f8 100755 --- a/etc/committer.scm.in +++ b/etc/committer.scm.in @@ -7,6 +7,7 @@ ;;; Copyright © 2021 Sarah Morgensen ;;; Copyright © 2021 Xinglu Chen ;;; Copyright © 2022 Maxim Cournoyer +;;; Copyright © 2023 Antero Mejr ;;; ;;; This file is part of GNU Guix. ;;; @@ -35,13 +36,15 @@ (srfi srfi-9) (srfi srfi-11) (srfi srfi-26) + (srfi srfi-37) (ice-9 format) (ice-9 popen) (ice-9 match) (ice-9 rdelim) (ice-9 regex) (ice-9 textual-ports) - (guix gexp)) + (guix gexp) + (guix scripts)) (define* (break-string str #:optional (max-line-length 70)) "Break the string STR into lines that are no longer than MAX-LINE-LENGTH. @@ -138,7 +141,7 @@ (define (diff-info) ;; new definitions with changes to existing ;; definitions. "--unified=1" - "--" "gnu"))) + "--" (%package-dir)))) (define (extract-line-number line-tag) (abs (string->number (car (string-split line-tag #\,))))) @@ -221,7 +224,11 @@ (define (new-sexp hunk) (+ (lines-to-first-change hunk) (hunk-new-line-number hunk)))))) -(define* (change-commit-message file-name old new #:optional (port (current-output-port))) +(define (prepend-package-dir msg) + (format #f "~a: ~a" (%package-dir) msg)) + +(define* (change-commit-message file-name old new + #:optional (port (current-output-port))) "Print ChangeLog commit message for changes between OLD and NEW." (define (get-values expr field) (match ((xpath:sxpath `(// ,field quasiquote *)) expr) @@ -247,7 +254,8 @@ (define version (and=> ((xpath:sxpath '(// version *any*)) new) first)) (format port - "gnu: ~a: Update to ~a.~%~%* ~a (~a): Update to ~a.~%" + (prepend-package-dir + "~a: Update to ~a.~%~%* ~a (~a): Update to ~a.~%") variable-name version file-name variable-name version) (for-each (lambda (field) (let ((old-values (get-values old field)) @@ -276,14 +284,15 @@ (define* (add-commit-message file-name variable-name #:optional (port (current-output-port))) "Print ChangeLog commit message for a change to FILE-NAME adding a definition." - (format port "gnu: Add ~a.~%~%* ~a (~a): New variable.~%" + (format port (prepend-package-dir "Add ~a.~%~%* ~a (~a): New variable.~%") variable-name file-name variable-name)) (define* (remove-commit-message file-name variable-name #:optional (port (current-output-port))) "Print ChangeLog commit message for a change to FILE-NAME removing a definition." - (format port "gnu: Remove ~a.~%~%* ~a (~a): Delete variable.~%" + (format port (prepend-package-dir + "Remove ~a.~%~%* ~a (~a): Delete variable.~%") variable-name file-name variable-name)) (define* (custom-commit-message file-name variable-name message changelog @@ -301,7 +310,8 @@ (define (changelog-has-location? changelog) (let* ((message (trim message)) (changelog (if changelog (trim changelog) message)) - (message/f (format #f "gnu: ~a: ~a." variable-name message)) + (message/f (format #f (prepend-package-dir "~a: ~a.") + variable-name message)) (changelog/f (if (changelog-has-location? changelog) (format #f "* ~a (~a)~a." file-name variable-name changelog) @@ -348,10 +358,51 @@ (define (new+old+hunks hunks) (define %delay 1000) +;;; +;;; Command line options. +;;; + +(define (show-help) + (display "Usage: committer.scm [OPTION] [MESSAGE] [CHANGELOG] +Git commit unstaged package definition additions, removals, or changes. + +For changes, MESSAGE and CHANGELOG may be specified to set the message and +body sections of the commit message, respectively.\n") + (display " +-p, --package-directory=DIRECTORY search DIRECTORY for package definitions + (default: \"gnu\")") + (newline) + (display " +-h, --help display this help and exit") + (newline)) + +(define %options + ;; Specification of the command-line options. + (list (option '(#\p "package-directory") #t #f + (lambda (opt name arg result) + (alist-cons 'package-dir arg result))) + (option '(#\h "help") #f #f + (lambda args + (show-help) + (exit 0))))) + +(define %default-options + ;; Alist of default option values. + '((package-dir . "gnu"))) + +(define %package-dir (make-parameter #f)) + (define (main . args) + (define opts (parse-command-line args %options (list %default-options) + #:build-options? #f)) + (%package-dir (assoc-ref opts 'package-dir)) + (define* (change-commit-message* file-name old new #:rest rest) (let ((changelog #f)) - (match args + (match (reverse (filter-map (match-lambda + (('argument . x) x) + (_ #f)) + opts)) ((or (message changelog) (message)) (apply custom-commit-message file-name (second old) message changelog rest))