summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/contribute.html59
-rw-r--r--docs/docs.html2
-rw-r--r--docs/download.html24
-rw-r--r--docs/header.html3
-rw-r--r--docs/index.html3
-rw-r--r--docs/js/buildroot.js2
-rw-r--r--docs/manual/adding-packages-generic.txt3
-rw-r--r--docs/manual/adding-packages-virtual.txt15
-rw-r--r--docs/manual/common-usage.txt14
-rw-r--r--docs/manual/customize-packages.txt2
-rw-r--r--docs/manual/make-tips.txt3
-rw-r--r--docs/manual/manual.txt10
-rw-r--r--docs/news.html38
-rw-r--r--docs/support.html32
14 files changed, 133 insertions, 77 deletions
diff --git a/docs/contribute.html b/docs/contribute.html
index 1a2042dbf1..91959f801b 100644
--- a/docs/contribute.html
+++ b/docs/contribute.html
@@ -2,38 +2,31 @@
<h2>Contribute</h2>
-Buildroot is an open source project and if you want to contribute, here a few
-pointers to get you started.
-
-<p>Don't forget to look at <a href="./support.html">Support</a> if you need any
-help.
-And thanks for your help !</p>
-
-<h3>Autobuilders</h3>
-
-The <a href="http://autobuild.buildroot.org/">Autobuilders</a> are used to test
-Buildroot with a lot of differents settings (toolchains, various packages, etc)
-on all the supported platforms.
-
-<p>But despite our best effort, sometimes it fails.</p>
-<p>That's where you can help ! Look at a package that fails and try to fix it !</p>
-
-<h3>Wiki</h3>
-
-Have a look at the <a href="http://elinux.org/Buildroot">eLinux Wiki</a> a todo
-list is available there, which can help you find out what you could do to help
-Buildroot.
-
-<h3>Patchwork</h3>
-
-<a href="http://patchwork.ozlabs.org/project/buildroot/list/">Patchwork</a>
-is a patch tracking system, if you submit a patch, it will appear here.
-
-<p>You can have a look at a patch that interests you and test it on your machine,
-if it succeeds, you can send a <a
- href="http://buildroot.org/downloads/manual/manual.html#_reviewing_testing_patches">"Tested-by"</a>,
-if it fails, you can also send a mail on the <a
- href="http://buildroot.org/downloads/manual/manual.html#_mailing_list">mailing
- list</a> and report what has happened to you.</p>
+<p>Buildroot is an open source project and you are very welcome to contribute to
+it.<br />
+There are many different ways to contribute:</p>
+
+<ul>
+<li>Reproducing, analyzing and fixing bugs from our
+ <a href="https://bugs.buildroot.org/">bug tracker</a></li>
+<li>Analyzing and fixing <a href="http://autobuild.buildroot.org/">
+ autobuild failures</a></li>
+<li>Reviewing and testing patches sent by other developers. See the
+ <a href="http://lists.busybox.net/mailman/listinfo/buildroot">mailing list
+ </a> or <a href="http://patchwork.ozlabs.org/project/buildroot/list/">
+ patchwork</a>.</li>
+<li>Working on items from the
+ <a href="http://www.elinux.org/Buildroot#Todo_list">TODO list</a></li>
+<li>Submitting your own patches through the
+ <a href="http://lists.busybox.net/mailman/listinfo/buildroot">mailing list
+ </a></li>
+</ul>
+
+<p>For more details on these topics, check out the
+<a href="http://buildroot.uclibc.org/downloads/manual/manual.html#_contributing_to_buildroot">
+Contributing to buildroot</a> chapter in the Buildroot manual. Thanks for your help!</p>
+
+<p>If you need any support yourself, have a look at <a href="./support.html">
+Support</a>.</p>
<!--#include file="footer.html" -->
diff --git a/docs/docs.html b/docs/docs.html
index 77047b90c5..9ddc05967b 100644
--- a/docs/docs.html
+++ b/docs/docs.html
@@ -34,7 +34,7 @@ help:</p>
<li>On the <a href="irc://freenode.net/#buildroot">Buildroot IRC
channel</a>, <code>#buildroot</code> on Freenode</li>
- <li>On our <a href="https://bugs.uclibc.org">bugtracker</a>.</li>
+ <li>On our <a href="https://bugs.buildroot.org">bugtracker</a>.</li>
<li>Through the various companies offering commercial Buildroot
support.</li>
diff --git a/docs/download.html b/docs/download.html
index 2d18c65461..da58068a7b 100644
--- a/docs/download.html
+++ b/docs/download.html
@@ -4,32 +4,32 @@
<p>
-The latest stable release is <b>2014.02</b>, which can be downloaded
+The latest stable release is <b>2014.05</b>, which can be downloaded
here:<p>
-<a href="/downloads/buildroot-2014.02.tar.gz">buildroot-2014.02.tar.gz</a>
-(<a href="/downloads/buildroot-2014.02.tar.gz.sign">PGP signature</a>)
+<a href="/downloads/buildroot-2014.05.tar.gz">buildroot-2014.05.tar.gz</a>
+(<a href="/downloads/buildroot-2014.05.tar.gz.sign">PGP signature</a>)
or
-<a href="/downloads/buildroot-2014.02.tar.bz2">buildroot-2014.02.tar.bz2</a>
-(<a href="/downloads/buildroot-2014.02.tar.bz2.sign">PGP signature</a>).
+<a href="/downloads/buildroot-2014.05.tar.bz2">buildroot-2014.05.tar.bz2</a>
+(<a href="/downloads/buildroot-2014.05.tar.bz2.sign">PGP signature</a>).
<p>
-
-The latest release candidate is <b>2014.05-rc1</b>, which can be
+<!--
+The latest release candidate is <b>2014.05-rc3</b>, which can be
downloaded here:<p>
-<a href="/downloads/buildroot-2014.05-rc1.tar.gz">buildroot-2014.05-rc1.tar.gz</a>
-(<a href="/downloads/buildroot-2014.05-rc1.tar.gz.sign">PGP signature</a>)
+<a href="/downloads/buildroot-2014.05-rc3.tar.gz">buildroot-2014.05-rc3.tar.gz</a>
+(<a href="/downloads/buildroot-2014.05-rc3.tar.gz.sign">PGP signature</a>)
or
-<a href="/downloads/buildroot-2014.05-rc1.tar.bz2">buildroot-2014.05-rc1.tar.bz2</a>
-(<a href="/downloads/buildroot-2014.05-rc1.tar.bz2.sign">PGP signature</a>).
+<a href="/downloads/buildroot-2014.05-rc3.tar.bz2">buildroot-2014.05-rc3.tar.bz2</a>
+(<a href="/downloads/buildroot-2014.05-rc3.tar.bz2.sign">PGP signature</a>).
<p>
This and earlier releases (and their PGP signatures) can always be downloaded from
<a href="/downloads/">http://buildroot.net/downloads/</a>.
<p>
-
+-->
You can also obtain <a href="/downloads/snapshots/">Daily
Snapshots</a> of the latest Buildroot source tree if you want to to
follow development, but cannot or do not wish to use Git.
diff --git a/docs/header.html b/docs/header.html
index 93a4d51146..c1eba22ba6 100644
--- a/docs/header.html
+++ b/docs/header.html
@@ -47,7 +47,8 @@
<li><a href="/contribute.html">Contribute</a></li>
<li><a href="/sponsors.html">Sponsors</a></li>
</ul>
- <a class="gplus" href="https://plus.google.com/100084591154899263420/posts"><img src="images/gplus.png" height="28" width="28"></a>
+ <a class="gplus" href="https://plus.google.com/100084591154899263420/posts">
+ <img src="images/gplus.png" height="28" width="28" alt="Google+" /></a>
</div><!--/.nav-collapse -->
</div>
</div>
diff --git a/docs/index.html b/docs/index.html
index c1eadfb72f..f5c0ea700e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -2,7 +2,8 @@
<div class="hero-unit">
<div class="row-fluid">
- <img src="images/logo.png" height="170" width="170" style="float: right;"/>
+ <img src="images/logo.png" height="170" width="170" style="float: right;"
+ alt="Buildroot logo" />
<div class="span8">
<h1>Buildroot<br/><small>Making Embedded Linux Easy</small></h1>
<p>Buildroot is a simple, efficient and easy-to-use tool to generate
diff --git a/docs/js/buildroot.js b/docs/js/buildroot.js
index 410b703150..55e5eb3ca9 100644
--- a/docs/js/buildroot.js
+++ b/docs/js/buildroot.js
@@ -36,7 +36,7 @@ function load_activity(feedurl, divid) {
function initialize() {
load_activity("http://rss.gmane.org/topics/excerpts/gmane.comp.lib.uclibc.buildroot", "mailing-list-activity");
- load_activity("http://git.uclibc.org/buildroot/atom/?h=master", "commit-activity");
+ load_activity("http://git.buildroot.org/buildroot/atom/?h=master", "commit-activity");
}
function google_analytics() {
diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index f421651bb0..d3fa45b010 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -304,6 +304,9 @@ information is (assuming the package name is +libfoo+) :
a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for
the current host package.
+* +LIBFOO_PROVIDES+ lists all the virtual packages +libfoo+ is an
+ implementation of. See xref:virtual-package-tutorial[].
+
* +LIBFOO_INSTALL_STAGING+ can be set to +YES+ or +NO+ (default). If
set to +YES+, then the commands in the +LIBFOO_INSTALL_STAGING_CMDS+
variables are executed to install the package into the staging
diff --git a/docs/manual/adding-packages-virtual.txt b/docs/manual/adding-packages-virtual.txt
index 1c1116f2bc..0cbe753682 100644
--- a/docs/manual/adding-packages-virtual.txt
+++ b/docs/manual/adding-packages-virtual.txt
@@ -39,7 +39,7 @@ In this file, we declare two options, +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+ and
+BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+, whose values will be used by the
providers.
-==== Virtual package's +*.mk+ file
+==== Virtual package's +.mk+ file
The +.mk+ for the virtual package should just evaluate the +virtual-package+ macro:
@@ -59,8 +59,7 @@ The ability to have target and host packages is also available, with the
==== Provider's +Config.in+ file
When adding a package as a provider, only the +Config.in+ file requires some
-modifications. The +*.mk+ file should follow the Buildroot infrastructure with
-no change at all.
+modifications.
The +Config.in+ file of the package 'some-provider', which provides the
functionalities of 'something-virtual', should contain:
@@ -84,6 +83,16 @@ On line 3, we select +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+, and on line 11, we
set the value of +BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+ to the name of the
provider, but only if it is selected.
+==== Provider's +.mk+ file
+
+The +.mk+ file should also declare an additional variable
++SOME_PROVIDER_PROVIDES+ to contain the names of all the virtual
+packages it is an implementation of:
+
+---------------------------
+01: SOME_PROVIDER_PROVIDES = something-virtual
+---------------------------
+
Of course, do not forget to add the proper build and runtime dependencies for
this package!
diff --git a/docs/manual/common-usage.txt b/docs/manual/common-usage.txt
index 3d5842d333..772982af5c 100644
--- a/docs/manual/common-usage.txt
+++ b/docs/manual/common-usage.txt
@@ -92,8 +92,8 @@ to +make+ or set in the environment:
build-time graphs
* +BR2_GRAPH_OUT+ to set the filetype of generated graphs, either +pdf+ (the
default), or +png+.
-* +BR2_GRAPH_DEPTH+ (an integer) to limit the depth of the dependency graph.
- The default, +0+, is to not limit the depth.
+* +BR2_GRAPH_DEPS_OPTS+ to pass extra options to the dependency graph; see
+ xref:graph-depends[] for the accepted options
An example that uses config files located in the toplevel directory and
in your $HOME:
@@ -198,6 +198,16 @@ supported.
BR2_GRAPH_OUT=svg make graph-depends
--------------------------------
+The +graph-depends+ behaviour can be controlled by setting options in the
++BR2_GRAPH_DEPS_OPTS+ environment variable. The accepted options are:
+
+* +--depth N+, +-d N+, to limit the dependency depth to +N+ levels. The
+ default, +0+, means no limit.
+
+--------------------------------
+BR2_GRAPH_DEPS_OPTS='-d 3' make graph-depends
+--------------------------------
+
=== Graphing the build duration
[[graph-duration]]
diff --git a/docs/manual/customize-packages.txt b/docs/manual/customize-packages.txt
index 6f70bdb43f..b4ed0b5a42 100644
--- a/docs/manual/customize-packages.txt
+++ b/docs/manual/customize-packages.txt
@@ -86,7 +86,7 @@ If the user has the +BR2_GLOBAL_PATCH_DIR+ configuration option set as
follows:
-----
-BR2_GLOBAL_PATCH_DIR="board/common-fooarch board/fooarch-board"
+BR2_GLOBAL_PATCH_DIR="board/common-fooarch/patches board/fooarch-board/patches"
-----
Then the patches would applied as follows for the Linux kernel:
diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
index 13609434e8..9fabb6f742 100644
--- a/docs/manual/make-tips.txt
+++ b/docs/manual/make-tips.txt
@@ -31,8 +31,7 @@ The result of the search shows the help message of the matching items.
Not all targets are always available,
some settings in the +.config+ file may hide some targets:
-* +busybox-menuconfig+ and +busybox-savedefconfig+ only work when
- +busybox+ is enabled;
+* +busybox-menuconfig+ only works when +busybox+ is enabled;
* +linux-menuconfig+ and +linux-savedefconfig+ only work when
+linux+ is enabled;
* +uclibc-menuconfig+ is only available when the uClibc C library is
diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt
index 94259f70eb..bf89af9ee5 100644
--- a/docs/manual/manual.txt
+++ b/docs/manual/manual.txt
@@ -4,12 +4,16 @@
= The Buildroot user manual
:toc:
-Buildroot usage and documentation by Thomas Petazzoni. Contributions
-from Karsten Kruse, Ned Ludd, Martin Herren and others.
-
Buildroot {sys:echo $\{BR2_VERSION%%-git*\}} manual generated on {localdate}
{localtime} from git revision {sys:git rev-parse --short HEAD}
+The Buildroot manual is written by the Buildroot developers.
+It is licensed under the GNU General Public License, version 2. Refer to the
+http://git.buildroot.org/buildroot/tree/COPYING[COPYING] file in the Buildroot
+sources for the full text of this license.
+
+Copyright (C) 2004-2014 The Buildroot developers
+
image::logo.png[]
:leveloffset: 1
diff --git a/docs/news.html b/docs/news.html
index 8a6f6420d1..19f2b13134 100644
--- a/docs/news.html
+++ b/docs/news.html
@@ -6,12 +6,48 @@
<ul>
+ <li><b>31 May 2014 -- 2014.05 released</b>
+
+ <p>The stable 2014.05 release is out - Thanks to everyone
+ contributing and testing the release candidates. See the
+ <a href="http://git.buildroot.net/buildroot/plain/CHANGES?id=2014.05">CHANGES</a>
+ file for more details, read the
+ <a href="http://lists.busybox.net/pipermail/buildroot/2014-May/097863.html">announcement</a>
+ and go to the <a href="/downloads/">downloads page</a> to pick up the
+ <a href="/downloads/buildroot-2014.05.tar.bz2">2014.05 release</a>.</p>
+
+ <li><b>28 May 2014 -- 2014.05-rc3 released</b>
+
+ <p>Release candidate 3 is out with more cleanups and build fixes. See the <a
+ href="http://git.buildroot.net/buildroot/plain/CHANGES?id=2014.05-rc3">CHANGES</a>
+ file for details.</p>
+
+ <p>Head to the <a href="/downloads/">downloads page</a> to pick up the
+ <a href="/downloads/buildroot-2014.05-rc3.tar.bz2">2014.05-rc3
+ release candidate</a>, and report any problems found to the <a
+ href="lists.html">mailing list</a> or <a
+ href="https://bugs.uclibc.org">bug tracker</a>.</p>
+
+ <li><b>21 May 2014 -- 2014.05-rc2 released</b>
+
+ <p>Another week, another release candidate with more cleanups and
+ build fixes. See the <a
+ href="http://git.buildroot.net/buildroot/plain/CHANGES?id=2014.05-rc2">CHANGES</a>
+ file for details.</p>
+
+ <p>Head to the <a href="/downloads/">downloads page</a> to pick up the
+ <a href="/downloads/buildroot-2014.05-rc2.tar.bz2">2014.05-rc2
+ release candidate</a>, and report any problems found to the <a
+ href="support.html">mailing list</a> or <a
+ href="https://bugs.uclibc.org">bug tracker</a>.</p>
+
<li><b>13 May 2014 -- 2014.05-rc1 released</b>
<p>We have a new release candidate! Lots of changes all over the
tree, see the <a
href="http://git.buildroot.net/buildroot/plain/CHANGES?id=2014.05-rc1">CHANGES</a>
- file for details.</p>
+ file for details, and read the
+ <a href="http://lists.busybox.net/pipermail/buildroot/2014-May/096492.html">announcement</a>.</p>
<p>Head to the <a href="/downloads/">downloads page</a> to pick up the
<a href="/downloads/buildroot-2014.05-rc1.tar.bz2">2014.05-rc1
diff --git a/docs/support.html b/docs/support.html
index 4cc493247d..5fa3cde651 100644
--- a/docs/support.html
+++ b/docs/support.html
@@ -2,32 +2,31 @@
<h2>Support</h2>
-You can get support for Buildroot through three main channels:
+<p>You can get support for Buildroot through three main channels:</p>
<h3>IRC</h3>
-The Buildroot IRC is <a href="irc://freenode.net/#buildroot">#buildroot</a>.
-The channel #buildroot is hosted on Freenode <a href="http://webchat.freenode.net">WebChat</a>.
-
+<p>The Buildroot IRC channel is <a href="irc://freenode.net/#buildroot">
+#buildroot</a>, hosted on Freenode. If you do not have an IRC client, you can
+use the <a href="http://webchat.freenode.net">Freenode web interface</a>.
When asking for help on IRC, share relevant logs or pieces of code using a code
-sharing website.
+sharing website.</p>
<h3>Mailing List Information</h3>
-The <a href="/lists/buildroot/">mailing list</a> is for discussion and
+<p>The <a href="/lists/buildroot/">mailing list</a> is for discussion and
development. You can subscribe by visiting
<a href="http://lists.busybox.net/mailman/listinfo/buildroot">this page</a>.
Only subscribers to the Buildroot mailing list are allowed to post
-to this list.
-<p>
-The list is also available through <a
+to this list.</p>
+
+<p>The list is also available through <a
href="http://gmane.org">Gmane</a> at <a href="http://dir.gmane.org/gmane.comp.lib.uclibc.buildroot">gmane.comp.lib.uclibc.buildroot</a>.
-<p>
+</p>
<h4>Search the List Archives</h4>
-Please search the mailing list archives before asking questions on the mailing
+<p>Please search the mailing list archives before asking questions on the mailing
list, since there is a good chance someone else has asked the same question
before. Checking the archives is a great way to avoid annoying everyone on the
-list with frequently asked questions...
-<p>
+list with frequently asked questions...</p>
<form method="get" action="http://search.gmane.org/">
<input type="text" name="query">
@@ -37,9 +36,10 @@ list with frequently asked questions...
<h3>Bug Tracker</h3>
-If you encounter any problems while using Buildroot, you can use the <a href="https://bugs.uclibc.org/">Bug Tracker</a>
-to post your bugs and/or participate to find solutions to existing problems.
+<p>If you encounter any problem while using Buildroot, you can use the
+<a href="https://bugs.buildroot.org/">Bug Tracker</a> to post your bugs and/or
+participate to find solutions to existing problems.</p>
-Note: Patch are only accepted through the mailing list.
+<p>Note: patches are only accepted through the mailing list.</p>
<!--#include file="footer.html" -->
OpenPOWER on IntegriCloud