From patchwork Tue Mar 20 23:10:01 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Samuel Martin X-Patchwork-Id: 147866 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from fraxinus.osuosl.org (fraxinus.osuosl.org [140.211.166.137]) by ozlabs.org (Postfix) with ESMTP id 533D7B6FC5 for ; Wed, 21 Mar 2012 10:12:35 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id 42775101289; Tue, 20 Mar 2012 23:12:34 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id aA1UB2JSG88t; Tue, 20 Mar 2012 23:12:27 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by fraxinus.osuosl.org (Postfix) with ESMTP id 95D6B100DF2; Tue, 20 Mar 2012 23:11:22 +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 08E898F75B for ; Tue, 20 Mar 2012 23:11:07 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id E9BF98D0AB for ; Tue, 20 Mar 2012 23:11:06 +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 sYoPj3tbi02K for ; Tue, 20 Mar 2012 23:11:05 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-wg0-f53.google.com (mail-wg0-f53.google.com [74.125.82.53]) by whitealder.osuosl.org (Postfix) with ESMTPS id 192CB8D0AE for ; Tue, 20 Mar 2012 23:11:04 +0000 (UTC) Received: by mail-wg0-f53.google.com with SMTP id fm10so321896wgb.10 for ; Tue, 20 Mar 2012 16:11:04 -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:x-mailer:in-reply-to:references; bh=rosAhpYqtIHHhL4dfeROegjLvkocLfa50+zwpd7kQfw=; b=crnGujbHR/fpcwJ4tnwgJAW4cjk7ZUtSIAi/sHjxW3Qx834dYoqirYPNTcHKXICHbD n/MLAPrsC8eIMuZrcKC2aqYdMpn00K3xPsbjSI9ajATJHavX+/Sehkp0j0P1cuv2vMSJ XAdOKz2eLIMqTO28FPcGss6L62OF40GNaFbOwsMtG0t4eMyE/RIQ4v9a5vNFCGeOrCKe rfPFiHTkUHNHDbVNj1MtpQOpoT885BW3yLQSNTSNeAD+XaPo57tFzZJ+Z6d+NSCcs92p rYPH/CmFHICADfk8+UsYR0QuCDn3nKdCNsEwrG+ealaM01Il76TQh4cjR8ZqTZv+hfne /qbg== Received: by 10.180.106.9 with SMTP id gq9mr3710851wib.17.1332285064702; Tue, 20 Mar 2012 16:11:04 -0700 (PDT) Received: from localhost.localdomain (ivr94-4-82-229-165-48.fbx.proxad.net. [82.229.165.48]) by mx.google.com with ESMTPS id fz9sm37727837wib.3.2012.03.20.16.11.03 (version=SSLv3 cipher=OTHER); Tue, 20 Mar 2012 16:11:03 -0700 (PDT) From: Samuel MARTIN To: buildroot@busybox.net Date: Wed, 21 Mar 2012 00:10:01 +0100 Message-Id: <1332285001-12881-12-git-send-email-s.martin49@gmail.com> X-Mailer: git-send-email 1.7.9.4 In-Reply-To: <1332285001-12881-1-git-send-email-s.martin49@gmail.com> References: <1332285001-12881-1-git-send-email-s.martin49@gmail.com> Subject: [Buildroot] [PATCH 11/11] manual: update contribute.txt 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 Signed-off-by: Samuel MARTIN --- docs/manual/contribute.txt | 61 ++++++++++++++++++++++++++++++++++++++++++++ docs/manual/getting.txt | 1 + 2 files changed, 62 insertions(+) diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt index 30ae800..d80e79a 100644 --- a/docs/manual/contribute.txt +++ b/docs/manual/contribute.txt @@ -1,2 +1,63 @@ Contibuting to Buildroot ======================== + +If you want to contribute to Buildroot, you will need a git view of +the project. Refer to xref:getting-buildroot[] to get it. + +Currently, the mailing list is the central place for contribution. +If you have not already subscribe to it, then refer to +xref:mailing-list-subscribe[]. + +Submiting patches +----------------- + +When your changes are done, and commited in your local git view, +_rebase_ your development branch on top of the upstream tree before +generating the patch set. To do so, run: + +--------------------- + $ git fetch --all --tags + $ git rebase origin/master +--------------------- + +Here, your are ready to generate then submit your patch set. + +To generate it, run: + +--------------------- + $ git format-patch -M -n -s -o outgoing origin/master +--------------------- + +This will generate patch files in the +outgoing+ subdirectory, +automatically adding the +signed-of-by+ line. + +If you want to present the whole patch set in a separate mail, add ++--cover-letter --summary+ to the previous command line (+man +git-format-patch+ for further information). + +Once patch files are generated, you can review/edit the commit message +before submitting them using your favourite text editor. + +Lastly, send/submit your patch set to the Buildroot mailing list: + +--------------------- + $ git send-email --to buildroot@busybox.net outgoing/* +--------------------- + +Note that +git+ should be configured to use your mail account. +To configure +git+, see +man git-send-email+ or google it. + +Reviewing/Testing patches +------------------------- + +In the review process, do not hesitate to respond to patch submissions +for remarks, suggestions or anything that will help everyone to +understand the patches and make them better. + +Some tags are used to help following the state of any patch posted on +the mailing-list: + +Acked-by:: Indicates that the patch can be committed. + +Tested-by:: Indicates that the patch has been tested. It is useful + but not necessary to add a comment about what has been tested. diff --git a/docs/manual/getting.txt b/docs/manual/getting.txt index 6cfdefb..8ad544a 100644 --- a/docs/manual/getting.txt +++ b/docs/manual/getting.txt @@ -1,6 +1,7 @@ [[getting-buildroot]] Getting Buildroot ----------------- +[[getting-buildroot]] Buildroot releases are made approximately every 3 months. Direct Git access and daily snapshots are also available, if you want more