|
@@ -1,8 +1,7 @@
|
|
|
// -*- mode:doc; -*-
|
|
|
// vim: set syntax=asciidoc:
|
|
|
|
|
|
-Contributing to Buildroot
|
|
|
-=========================
|
|
|
+= Contributing to Buildroot
|
|
|
|
|
|
There are many ways in which you can contribute to Buildroot: analyzing
|
|
|
and fixing bugs, analyzing and fixing package build failures detected by
|
|
@@ -23,8 +22,7 @@ source code tarball. Git is the easiest way to develop from and directly
|
|
|
send your patches to the mailing list. Refer to xref:getting-buildroot[]
|
|
|
for more information on obtaining a Buildroot git tree.
|
|
|
|
|
|
-Reproducing, analyzing and fixing bugs
|
|
|
---------------------------------------
|
|
|
+== Reproducing, analyzing and fixing bugs
|
|
|
|
|
|
A first way of contributing is to have a look at the open bug reports in
|
|
|
the https://bugs.busybox.net/buglist.cgi?product=buildroot[Buildroot bug
|
|
@@ -33,8 +31,7 @@ help in reproducing, analyzing and fixing reported bugs is more than
|
|
|
welcome. Don't hesitate to add a comment to bug reports reporting your
|
|
|
findings, even if you don't yet see the full picture.
|
|
|
|
|
|
-Analyzing and fixing autobuild failures
|
|
|
----------------------------------------
|
|
|
+== Analyzing and fixing autobuild failures
|
|
|
|
|
|
The Buildroot autobuilders are a set of build machines that continuously
|
|
|
run Buildroot builds based on random configurations. This is done for
|
|
@@ -79,8 +76,7 @@ basically two things that can be done:
|
|
|
Fixes http://autobuild.buildroot.org/results/51000a9d4656afe9e0ea6f07b9f8ed374c2e4069
|
|
|
---------------------
|
|
|
|
|
|
-Reviewing and testing patches
|
|
|
------------------------------
|
|
|
+== Reviewing and testing patches
|
|
|
|
|
|
With the amount of patches sent to the mailing list each day, the
|
|
|
maintainer has a very hard job to judge which patches are ready to apply
|
|
@@ -146,8 +142,7 @@ 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.
|
|
|
|
|
|
-Work on items from the TODO list
|
|
|
---------------------------------
|
|
|
+== Work on items from the TODO list
|
|
|
|
|
|
If you want to contribute to Buildroot but don't know where to start,
|
|
|
and you don't like any of the above topics, you can always work on items
|
|
@@ -157,8 +152,7 @@ Do edit the wiki to indicate when you start working on an item, so we
|
|
|
avoid duplicate efforts.
|
|
|
|
|
|
[[submitting-patches]]
|
|
|
-Submitting patches
|
|
|
-------------------
|
|
|
+== Submitting patches
|
|
|
|
|
|
[NOTE]
|
|
|
_Please, do not attach patches to bugs, send them to the mailing list
|
|
@@ -202,8 +196,7 @@ If you do not use +git send-email+, 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 yet, learn to use +git send-email+.
|
|
|
|
|
|
-Cover letter
|
|
|
-~~~~~~~~~~~~
|
|
|
+=== Cover letter
|
|
|
|
|
|
If you want to present the whole patch set in a separate mail, add
|
|
|
+--cover-letter+ to the +git format-patch+ command (see +man
|
|
@@ -222,8 +215,7 @@ in the following cases:
|
|
|
* whenever you feel it will help presenting your work, your choices,
|
|
|
the review process, etc.
|
|
|
|
|
|
-Patch revision changelog
|
|
|
-~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+=== Patch revision changelog
|
|
|
|
|
|
When improvements are requested, the new revision of each commit
|
|
|
should include a changelog of the modifications between each
|
|
@@ -281,8 +273,7 @@ $ git format-patch --subject-prefix "PATCH v4" \
|
|
|
---------------------
|
|
|
|
|
|
[[reporting-bugs]]
|
|
|
-Reporting issues/bugs or getting help
|
|
|
--------------------------------------
|
|
|
+== Reporting issues/bugs or getting help
|
|
|
|
|
|
Before reporting any issue, please check
|
|
|
xref:mailing-list-subscribe[the mailing list archive] in case someone has
|