manual: update review process and patchwork

Adding more documentaiton based on discussion from the mailing list
in regards the buildroot review process and how patchworks can be
used to pull in patches for testing purposes.

Mailing list discussion:
http://lists.busybox.net/pipermail/buildroot/2013-September/078170.html

Signed-off-by: Ryan Barnett <rjbarnet@rockwellcollins.com>
Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
This commit is contained in:
Ryan Barnett 2013-10-09 15:46:15 -05:00 committed by Peter Korsgaard
parent 4b1eba735e
commit 75c01bf213
2 changed files with 47 additions and 4 deletions

View File

@ -132,9 +132,15 @@ $ git format-patch --subject-prefix "PATCH v4" \
Reviewing/Testing patches
-------------------------
The review process for new patches is done over the mailing list. Once
a patch is submitted to the mailing list, other developers will provide
feedback to the patch via emails sent through the mailing list.
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.
understand the patches and make them better. Please use internet
style replies in plain text emails when responding to patch
submissions.
Some tags are used to help following the state of any patch posted on
the mailing-list:
@ -144,6 +150,10 @@ 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.
Buildroot's Patchwork website can be used to pull in patches for testing
purposes. Please see xref:apply-patches-patchwork[] for more
information on using Buildroot's Patchwork website to apply patches.
Autobuild
---------

View File

@ -55,11 +55,44 @@ using a code sharing website.
Patchwork
---------
The Buildroot patch management interface is at
Patchwork is a web-based patch tracking system designed to facilitate
the contribution and management of contributions to an open-source
project. Patches that have been sent to a mailing list are \'caught' by
the system, and appear on a web page. Any comments posted that
reference the patch are appended to the patch page too. For more
information on Patchwork see
http://jk.ozlabs.org/projects/patchwork[].
Buildroot's Patchwork website is mainly for use by Buildroot's
maintainer to ensure patches aren't missed. The website however,
exposes patches and their corresponding review comments in a clean
and concise web interface.
The Buildroot patch management interface is available at
http://patchwork.buildroot.org[].
All patches and comments sent through the mailing list are
automatically indexed in http://patchwork.buildroot.org[patchwork].
[[apply-patches-patchwork]]
Applying Patches from Patchwork
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The main use of Buildroot's Patchwork website for a developer is for
pulling in patches into their local git repository for testing
purposes.
When browsing patches in the patchwork management interface, an +mbox+
link is provided at the top of the page. Copy this link address and
run the following commands:
---------------------
$ git checkout -b <test-branch-name>
$ wget -O - <mbox-url> | git am
---------------------
Another option for applying patches is to create a bundle. A bundle is
a set of patches that you can group together using the patchwork
interface. Once the bundle is created and the bundle is made public,
you can copy the +mbox+ link for the bundle and apply the bundle
using the above commands.
[[bugtracker]]
Bugtracker