From nobody Sat Apr 27 19:33:02 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 1497497652220259.18188513861605; Wed, 14 Jun 2017 20:34:12 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id DCA923D948; Thu, 15 Jun 2017 03:34:09 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6020C7EA3A; Thu, 15 Jun 2017 03:34:08 +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 93D024BB7F; Thu, 15 Jun 2017 03:34:05 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id v5F3XOtG021180 for ; Wed, 14 Jun 2017 23:33:24 -0400 Received: by smtp.corp.redhat.com (Postfix) id 5A4357CD60; Thu, 15 Jun 2017 03:33:24 +0000 (UTC) Received: from inaba.usersys.redhat.com (ovpn-12-94.pek2.redhat.com [10.72.12.94]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 053877CD70; Thu, 15 Jun 2017 03:33:20 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com DCA923D948 Authentication-Results: ext-mx06.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx06.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 DCA923D948 From: Andrea Bolognani To: libvir-list@redhat.com Date: Thu, 15 Jun 2017 11:31:43 +0800 Message-Id: <1497497503-10453-1-git-send-email-abologna@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Cc: lizhu@redhat.com Subject: [libvirt] [PATCH] hacking: Improve 'git send-email' documentation 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.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Thu, 15 Jun 2017 03:34:10 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" For the benefit of first time contributors, we point out that 'git send-email' might have to be installed separately; however, we omit the fact that some configuration will likely be needed before it can successfully deliver patches to the mailing list. Some minor tweaks to the existing contents are included as well. Signed-off-by: Andrea Bolognani --- docs/hacking.html.in | 36 ++++++++++++++++++++++++------------ 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index d6a574c..434fb68 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -29,8 +29,8 @@ file from zanata.

=20 -

  • Post patches using "git send-email", with git rename - detection enabled. You need a one-time setup of:

    +

  • Post patches using git send-email, with git + rename detection enabled. You need a one-time setup of:

       git config diff.renames true
    @@ -52,20 +52,32 @@ git send-email --cover-letter --no-chain-reply-to --annotate \ --to=3Dlibvir-list@redhat.com master -

    (Note that the "git send-email" subcommand may not be in - the main git package and using it may require installation of a - separate package, for example the "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 can - set it in git config:

    +

    Note that the git send-email subcommand may not + be in the main git package and using it may require installation + of a separate package, for example the "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, you can + configure that to be automatically handled as well:

       git config sendemail.to libvir-list@redhat.com
    +

    For a single patch you can omit + --cover-letter, but a series of two or more + patches needs a cover letter.

    +

    If everything went well, your patch should show up on the + libvir-li= st + archives 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.

    Please follow this as close as you can, especially the rebase a= nd - git send-email part, as it makes life easier for other developers = to - review your patch set. One should avoid sending patches as attachm= ents, + git send-email part, as it makes life easier for other + developers to review your 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 --=20 2.7.5 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list