From patchwork Sun Sep 19 18:36:43 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sarah Morgensen X-Patchwork-Id: 33205 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 2B08327BBE3; Sun, 19 Sep 2021 19:40:10 +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 9F44E27BBE1 for ; Sun, 19 Sep 2021 19:40:09 +0100 (BST) Received: from localhost ([::1]:47046 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mS1jU-00085f-LI for patchwork@mira.cbaines.net; Sun, 19 Sep 2021 14:40:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:59358) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mS1gW-0003ut-Ht for guix-patches@gnu.org; Sun, 19 Sep 2021 14:37:04 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:56627) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mS1gU-0005BG-Ih for guix-patches@gnu.org; Sun, 19 Sep 2021 14:37:04 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mS1gU-0006AQ-CO for guix-patches@gnu.org; Sun, 19 Sep 2021 14:37:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#50363] [PATCH v3] Improve default diff hunk header detection. Resent-From: Sarah Morgensen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 19 Sep 2021 18:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50363 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 50363@debbugs.gnu.org Cc: ludo@gnu.org, maximedevos@telenet.be Received: via spool by 50363-submit@debbugs.gnu.org id=B50363.163207660923685 (code B ref 50363); Sun, 19 Sep 2021 18:37:02 +0000 Received: (at 50363) by debbugs.gnu.org; 19 Sep 2021 18:36:49 +0000 Received: from localhost ([127.0.0.1]:39940 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mS1gH-00069x-Cr for submit@debbugs.gnu.org; Sun, 19 Sep 2021 14:36:49 -0400 Received: from out0.migadu.com ([94.23.1.103]:52179) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mS1gE-00069n-PF for 50363@debbugs.gnu.org; Sun, 19 Sep 2021 14:36:48 -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=1632076605; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=PoAhtwiVR1r6L97YWFzO58zEw1DqC7PRqdCUL7NZTbI=; b=C3vBjZR/kSBTUBmKlEBAU1rUC+yDwierJJKwLzm6HAUFlrTaiHVxFDaxLymUcl3bcByNYq xf8sRv5FlV5fJJP0pL8u3N1wb+t9xPtrKt0tUKwxwYsVKv/ElfoYqMGTyHi5/bzTxoN/7A jy5cXOPcFlYZszrp6qz9qrF2QP1J7ro= From: Sarah Morgensen Date: Sun, 19 Sep 2021 11:36:43 -0700 Message-Id: <58187bb9c61bc7599cde31b52a5dd58e90c1f78f.1632076068.git.iskarian@mgsn.dev> In-Reply-To: References: MIME-Version: 1.0 X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: iskarian@mgsn.dev 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 Tell git where to look for diff hunk headers: top-level definitions for Scheme files, and (sub)section headers for texi files. * .gitattributes, etc/git/gitconfig: New files. * doc/contributing.texi ("Submitting Patches"): Add subsection "Configuring Git". Document etc/git/gitconfig. --- Changes from previous version: * Added rule for .texi files * Documented how to use the advanced settings in the manual (as well as some other related information) Note that I am currently working on a rewrite of "Submitting Patches", so "Configuring Git" will eventually get its own proper subsection. -- Sarah .gitattributes | 3 +++ doc/contributing.texi | 46 +++++++++++++++++++++++++++++++++++++++---- doc/guix.texi | 1 + etc/git/gitconfig | 5 +++++ 4 files changed, 51 insertions(+), 4 deletions(-) create mode 100644 .gitattributes create mode 100644 etc/git/gitconfig base-commit: 808f9ffbd3106da4c92d2367b118b98196c9e81e diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..51f29b8a48 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +*.scm diff=scheme +*.scm.in diff=scheme +*.texi diff=tex diff --git a/doc/contributing.texi b/doc/contributing.texi index d1b77d7d05..0e8747ab25 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -992,9 +992,12 @@ @section Submitting Patches Development is done using the Git distributed version control system. Thus, access to the repository is not strictly necessary. We welcome contributions in the form of patches as produced by @code{git -format-patch} sent to the @email{guix-patches@@gnu.org} mailing list. -Seasoned Guix developers may also want to look at the section on commit -access (@pxref{Commit Access}). +format-patch} sent to the @email{guix-patches@@gnu.org} mailing list +(@pxref{submitting patches,, Submitting patches to a project, git, Git +User Manual}). Contributors are encouraged to take a moment to set some +Git repository options (@pxref{Configuring Git}) first, which can +improve the readability of patches. Seasoned Guix developers may also +want to look at the section on commit access (@pxref{Commit Access}). This mailing list is backed by a Debbugs instance, which allows us to keep track of submissions (@pxref{Tracking Bugs and Patches}). Each @@ -1205,11 +1208,46 @@ @section Submitting Patches When a bug is resolved, please close the thread by sending an email to @email{@var{NNN}-done@@debbugs.gnu.org}. +@node Configuring Git +@subsection Configuring Git +@cindex git configuration +@cindex @code{git format-patch} +@cindex @code{git send-email} + +If you have not done so already, you may wish to set a name and email +that will be associated with your commits (@pxref{telling git your name, +, Telling Git your name, git, Git User Manual}). If you wish to use a +different name or email just for commits in this respository, you can +use @command{git config --local}, or edit @file{.git/config} in the +repository instead of @file{~/.gitconfig}. + +We provide some default settings in @file{etc/git/gitconfig} which +modify how patches are generated, making them easier to read and apply. +These settings can be applied by manually copying them to +@file{.git/config} in your checkout, or by telling Git to include the +whole file: + +@example +git config --local include.path=../etc/git/gitconfig +@end example + +From then on, any changes to @file{etc/git/gitconfig} would +automatically take effect. + +Since the first patch in a series must be sent separately +(@pxref{Sending a Patch Series}), it can also be helpful to tell +@command{git format-patch} to handle the e-mail threading instead of +@command{git send-email}: + +@example +git config --local format.thread=shallow +git config --local sendemail.thread=no +@end example + @unnumberedsubsec Sending a Patch Series @anchor{Sending a Patch Series} @cindex patch series @cindex @code{git send-email} -@cindex @code{git-send-email} When sending a patch series (e.g., using @code{git send-email}), please first send one message to @email{guix-patches@@gnu.org}, and then send diff --git a/doc/guix.texi b/doc/guix.texi index 6436e83a7c..4dac36310f 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -96,6 +96,7 @@ Copyright @copyright{} 2021 Hui Lu@* Copyright @copyright{} 2021 pukkamustard@* Copyright @copyright{} 2021 Alice Brenon@* +Copyright @copyright{} 2021 Sarah Morgensen@* Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or diff --git a/etc/git/gitconfig b/etc/git/gitconfig new file mode 100644 index 0000000000..290006816f --- /dev/null +++ b/etc/git/gitconfig @@ -0,0 +1,5 @@ +[diff "scheme"] + xfuncname = "^(\\(define.*)$" + +[diff "tex"] + xfuncname = "^(@((|sub|subsub)section|(unnumbered|appendix)((|sub|subsub)sec)|(|major|chap|sub|subsub)heading|chapter|part|titlepage|top)[ \t]+.*)$"