From nobody Fri May 3 08:43:59 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1498459216627997.3097356420111; Sun, 25 Jun 2017 23:40:16 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 42B0C3DD47; Mon, 26 Jun 2017 06:40:13 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 91981757DA; Mon, 26 Jun 2017 06:40:11 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 51E141841C41; Mon, 26 Jun 2017 06:40:08 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id v5Q6bgRZ015262 for ; Mon, 26 Jun 2017 02:37:42 -0400 Received: by smtp.corp.redhat.com (Postfix) id 7B6B67E49D; Mon, 26 Jun 2017 06:37:42 +0000 (UTC) Received: from inaba.usersys.redhat.com (unknown [10.43.2.82]) by smtp.corp.redhat.com (Postfix) with ESMTPS id ED52F7E49B for ; Mon, 26 Jun 2017 06:37:39 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 42B0C3DD47 Authentication-Results: ext-mx05.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx05.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=libvir-list-bounces@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 42B0C3DD47 From: Andrea Bolognani To: libvir-list@redhat.com Date: Mon, 26 Jun 2017 08:37:35 +0200 Message-Id: <1498459055-9445-1-git-send-email-abologna@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH] HACKING: Refresh after changes to source file X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]); Mon, 26 Jun 2017 06:40:14 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" Commit 79c1900fc1eb changed docs/hacking.html.in, but *of course* I forgot once again to update the text-only version of the file at the same time. Signed-off-by: Andrea Bolognani --- Pushed as trivial. HACKING | 54 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 38 insertions(+), 16 deletions(-) diff --git a/HACKING b/HACKING index b78a9ae..1d9f3f1 100644 --- a/HACKING +++ b/HACKING @@ -43,27 +43,49 @@ post your patches: git pull --rebase (fix any conflicts) git send-email --cover-letter --no-chain-reply-to --annotate \ - --to=3Dlibvir-list@redhat.com master + --confirm=3Dalways --to=3Dlibvir-list@redhat.com master =20 -(Note that the "git send-email" subcommand may not be in the main git pack= age +For a single patch you can omit "--cover-letter", but a series of two or m= ore +patches needs a cover letter. + +Note that the "git send-email" subcommand may not be in the main git packa= ge and using it may require installation of a separate package, for example t= he -"git-email" package in Fedora.) For a single patch you can omit -"--cover-letter", but a series of two or more patches needs a cover letter= . If -you get tired of typing "--to=3Dlibvir-list@redhat.com" designation you ca= n set -it in git config: +"git-email" package in Fedora and Debian. If this is your first time using +"git send-email", you might need to configure it to point it to your SMTP +server with something like: + + git config --global sendemail.smtpServer stmp.youremailprovider.net + +If you get tired of typing "--to=3Dlibvir-list@redhat.com" all the time, y= ou can +configure that to be automatically handled as well: =20 git config sendemail.to libvir-list@redhat.com =20 -Please follow this as close as you can, especially the rebase and git -send-email part, as it makes life easier for other developers to review yo= ur -patch set. One should avoid sending patches as attachments, but rather send -them in email body along with commit message. If a developer is sending -another version of the patch (e.g. to address review comments), they are -advised to note differences to previous versions after the "---" line in t= he -patch so that it helps reviewers but doesn't become part of git history. -Moreover, such patch needs to be prefixed correctly with -"--subject-prefix=3DPATCHv2" appended to "git send-email" (substitute "v2"= with -the correct version if needed though). +As a rule, patches should be sent to the mailing list only: all developers= are +subscribed to libvir-list and read it regularly, so please don't CC indivi= dual +developers unless they've explicitly asked you to. + +Avoid using mail clients for sending patches, as most of them will mangle = the +messages in some way, making them unusable for our purposes. Gmail and oth= er +Web-based mail clients are particularly bad at this. + +If everything went well, your patch should show up on the libvir-list arch= ives + in a matter of minutes; if = you +still can't find it on there after an hour or so, you should double-check = your +setup. Note that your very first post to the mailing list will be subject = to +moderation, and it's not uncommon for that to take around a day. + +Please follow this as close as you can, especially the rebase and "git +send-email" part, as it makes life easier for other developers to review y= our +patch set. + +One should avoid sending patches as attachments, but rather send them in e= mail +body along with commit message. If a developer is sending another version = of +the patch (e.g. to address review comments), they are advised to note +differences to previous versions after the "---" line in the patch so that= it +helps reviewers but doesn't become part of git history. Moreover, such pat= ch +needs to be prefixed correctly with "--subject-prefix=3DPATCHv2" appended = to +"git send-email" (substitute "v2" with the correct version if needed thoug= h). =20 (5) In your commit message, make the summary line reasonably short (60 cha= racters is typical), followed by a blank line, followed by any longer description = of --=20 2.7.5 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list