Patchwork [11/11] manual: update contribute.txt

login
register
mail settings
Submitter Samuel Martin
Date March 20, 2012, 11:10 p.m.
Message ID <1332285001-12881-12-git-send-email-s.martin49@gmail.com>
Download mbox | patch
Permalink /patch/147866/
State Superseded
Headers show

Comments

Samuel Martin - March 20, 2012, 11:10 p.m.
Signed-off-by: Samuel MARTIN <s.martin49@gmail.com>
---
 docs/manual/contribute.txt |   61 ++++++++++++++++++++++++++++++++++++++++++++
 docs/manual/getting.txt    |    1 +
 2 files changed, 62 insertions(+)

Patch

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