From patchwork Tue Aug 6 21:36:21 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Samuel Martin X-Patchwork-Id: 265248 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from hemlock.osuosl.org (hemlock.osuosl.org [140.211.166.133]) by ozlabs.org (Postfix) with ESMTP id A6ED42C007B for ; Wed, 7 Aug 2013 07:38:01 +1000 (EST) Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id EE7F693494; Tue, 6 Aug 2013 21:38:18 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id T0F6nEiXn-Pt; Tue, 6 Aug 2013 21:38:17 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by hemlock.osuosl.org (Postfix) with ESMTP id 0ADD39336B; Tue, 6 Aug 2013 21:38:17 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ash.osuosl.org (Postfix) with ESMTP id 0A5EA1BF983 for ; Tue, 6 Aug 2013 21:38:14 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id B8AD08CE90 for ; Tue, 6 Aug 2013 21:37:54 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id iqjiNwsbYwif for ; Tue, 6 Aug 2013 21:37:54 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-wi0-f182.google.com (mail-wi0-f182.google.com [209.85.212.182]) by whitealder.osuosl.org (Postfix) with ESMTPS id D36188CECD for ; Tue, 6 Aug 2013 21:37:53 +0000 (UTC) Received: by mail-wi0-f182.google.com with SMTP id hi8so959861wib.15 for ; Tue, 06 Aug 2013 14:37:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=cJ773GWtdEO6qeu6gPKgkBr7IMhrnLT/jw1uXGb1T3Y=; b=vOhhyt6JojOSICA8s7b1eqmUdtHOPWbebjolyGdhGGu19D51qPFXaw3hY9QN+uMLg0 wiS1ZvBbRcL/zbsZl6qcUpJcULStnDhkkRtwNZ2it5/kxnGSHdvzz72Wi6drHGgBui0p Oqg9uD7M90l3NgB77Kjf4B3HZQaQTiLSTAs74RJOcOsxOXRg+AsofO6I5AHDatV5Oop/ 9G7Exc85n1SJ40VStY5X2YMf0dZ/3lvUNtqlgMqH/hvsXm1y+e0nEFxAVjmUv6m273Ls 47RE1bermSav43Hzi/bZo/a2+6OXXA+PREkgaO5kvgJjZwM7RqQ+tzG6WluV9EvyaisZ 2tuA== X-Received: by 10.180.91.6 with SMTP id ca6mr166678wib.4.1375825072210; Tue, 06 Aug 2013 14:37:52 -0700 (PDT) Received: from localhost.localdomain (ANantes-655-1-163-177.w90-59.abo.wanadoo.fr. [90.59.150.177]) by mx.google.com with ESMTPSA id j20sm4971518wie.7.2013.08.06.14.37.51 for (version=TLSv1.2 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 06 Aug 2013 14:37:51 -0700 (PDT) From: Samuel Martin To: buildroot@busybox.net Date: Tue, 6 Aug 2013 23:36:21 +0200 Message-Id: <1375824984-8226-3-git-send-email-s.martin49@gmail.com> X-Mailer: git-send-email 1.8.3.4 In-Reply-To: <1375824984-8226-1-git-send-email-s.martin49@gmail.com> References: <1375824984-8226-1-git-send-email-s.martin49@gmail.com> Cc: Vinicius Tinti Subject: [Buildroot] [PATCH 2/5] manual: add patch revision and versioning section X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net From: Vinicius Tinti Improve the contribute manual section by adding an explanation about patch review and version. The section now provides advices in how to respond maintainers requests and how to proceed on replying them. [Samuel: minor rewordings + misc. formating fixes] Signed-off-by: Vinicius Tinti Signed-off-by: Samuel Martin --- docs/manual/contribute.txt | 66 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt index 0106df0..6d2cf5b 100644 --- a/docs/manual/contribute.txt +++ b/docs/manual/contribute.txt @@ -62,6 +62,72 @@ Make sure posted *patches are not line-wrapped*, otherwise they cannot easily be applied. In such a case, fix your e-mail client, or better, use +git send-email+ to send your patches. +Patch revision +~~~~~~~~~~~~~~ + +Sometimes, changes will be requested to your patch before getting merged. +Whenever it happens, the new revision of the pacthset should include a +changelog of the modifications between each submission, and being reposted, +as much as possible, as response to the original thread. + +Patch revision changelog +^^^^^^^^^^^^^^^^^^^^^^^^ + +When editing your commit, below the +signed-off-by+ section, add +---+, then +and your changelog below. + +Although the changelog will be visible for the reviewers in the mail +thread, as well as in http://patchwork.buildroot.org[patchwork], +git+ +will automatically ignore lines below +---+ when the patch will be +merged. + +For longer series, a per-patch changelog should be placed in each commit, +and the cover letter must contain a summary of these changes. + +The following suggested layout example is not mandatory. + +--------------- +Patch title less than 80-character length + +Some paragraph describing what the patch does and why + +Signed-off-by John Doe + +--- +Changes v2 -> v3: + - foo bar (suggested by Jane) + - bar buz + +Changes v1 -> v2: + - alpha bravo (suggested by John) + - charly delta +--------------- + +Any patch revision should include the version number. The version number +is simply composed by the letter +v+ followed by an +integer+ greater or +equal 2 (two) (i.e. "PATCH v2", "PATCH v3" ...). + +This can be easly handle in +git-format-patch+ command by using the option ++--subject-prefix+: + +--------------------- + $ git format-patch --subject-prefix "PATCH v4" -M -n -s -o outgoing origin/master +--------------------- + +Keeping patch revision in the same thread +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Mail clients will handle this automatically reply in the same thread but ++git+ won't. + +Hence the +--in-reply-to+ option in +git-send-email+ must be used. +Get the last +Message-ID+ (it can be found your mail client by accessing +the raw mail). Then use this message id to send your revision patch: + +--------------------- + $ git send-email --to buildroot@busybox.net --in-reply-to mymsgid@noname.org outgoing/* +--------------------- + Reviewing/Testing patches -------------------------