From patchwork Wed Jun 12 07:44:50 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: altadil X-Patchwork-Id: 28340 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 5D0FC27BBEA; Wed, 12 Jun 2024 08:46:21 +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=-3.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2, SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham 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 E071C27BBE2 for ; Wed, 12 Jun 2024 08:46:16 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sHIgH-00035f-UU; Wed, 12 Jun 2024 03:46:05 -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 1sHIgG-00030W-Ab for guix-patches@gnu.org; Wed, 12 Jun 2024 03:46:04 -0400 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 1sHIgG-0001LE-27 for guix-patches@gnu.org; Wed, 12 Jun 2024 03:46:04 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sHIgE-0004WL-JO for guix-patches@gnu.org; Wed, 12 Jun 2024 03:46:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#71502] [PATCH][DOCUMENTATION] doc: Clarify when to use guix style when submitting patches. Resent-From: altadil Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 12 Jun 2024 07:46:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 71502 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 71502@debbugs.gnu.org Cc: altadil X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.171817830317301 (code B ref -1); Wed, 12 Jun 2024 07:46:02 +0000 Received: (at submit) by debbugs.gnu.org; 12 Jun 2024 07:45:03 +0000 Received: from localhost ([127.0.0.1]:37455 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sHIfG-0004Ux-MT for submit@debbugs.gnu.org; Wed, 12 Jun 2024 03:45:03 -0400 Received: from lists.gnu.org ([209.51.188.17]:49290) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sHIfE-0004UD-GA for submit@debbugs.gnu.org; Wed, 12 Jun 2024 03:45:01 -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 1sHIfF-0002bw-GH for guix-patches@gnu.org; Wed, 12 Jun 2024 03:45:01 -0400 Received: from mail-40130.protonmail.ch ([185.70.40.130]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sHIfD-00012t-Se for guix-patches@gnu.org; Wed, 12 Jun 2024 03:45:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail3; t=1718178296; x=1718437496; bh=odcsceQxictzCwrxDeO3EiGGQGM25I4hquZZ4LIu644=; h=Date:To:From:Cc:Subject:Message-ID:Feedback-ID:From:To:Cc:Date: Subject:Reply-To:Feedback-ID:Message-ID:BIMI-Selector; b=DqpZP284WN8QWnlzUDVoDIn+HNDVOmsW+XS2UySfbmUYDU7rU7+VdI8bVnUoYhhxc JQKtPX8zHYeGyIRbq0cdP0XXz3s8Pq3L5ijz9VZG2yZGbpLURVElPVVy7F8c1gJpSL VFibasaXNFqRpMT8nB955Vayu2Jd6PG0xn/9mu4GFOtAZExHRz/osyIcyVDQyqCk7j rWPkhXOnJLEv+k56dRDQfHo7tHML9n31siwMXZ4RryOJNsW2szqmNTtQCH7LfWBhVn uoJmpVvhpao8xA3EACVtRnWAM6bxcBD45Z4oiY/tQfOKLxtWyR145YHXE0IPvZXZMb TBT40/C+ajw6g== Date: Wed, 12 Jun 2024 07:44:50 +0000 Message-ID: <20240612074419.13282-1-altadil@protonmail.com> Feedback-ID: 3841829:user:proton X-Pm-Message-ID: b031584ba6ec4445dc4e458d4f1facf4ab74c1c4 MIME-Version: 1.0 Received-SPF: pass client-ip=185.70.40.130; envelope-from=Altadil@protonmail.com; helo=mail-40130.protonmail.ch X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, FREEMAIL_FROM=0.001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: , Reply-to: altadil X-ACL-Warn: , altadil via Guix-patches X-Patchwork-Original-From: altadil via Guix-patches via From: altadil 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 Make more explicit the need to run guix style for new packages only, not for updates. * doc/contributing.texi (Submitting Patches): clarify the fourth item of the checklist. Change-Id: I69e1a6144b4da4814d2c8d9b44c7f77490183556 --- A newbie like me can easily miss the "new" here and mix guix style with other changes. So let’s make it extra clear. doc/contributing.texi | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/contributing.texi b/doc/contributing.texi index b8adc169d8..33ef94bba3 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1891,8 +1891,10 @@ name of the new or modified package, and fix any errors it reports (@pxref{Invoking guix lint}). @item -Run @code{guix style @var{package}} to format the new package definition -according to the project's conventions (@pxref{Invoking guix style}). +For a new package, run @code{guix style @var{package}} to format the package +definition according to the project's conventions (@pxref{Invoking guix style}). +For an update to an existing package, it’s better to skip this step, as it +would make reviewing the changes harder. @item Make sure the package builds on your platform, using @code{guix build