[Buildroot] [git commit] manual/getting started: rework 'System requirements' section
thomas.petazzoni at free-electrons.com
Sun Aug 17 19:09:52 UTC 2014
This patch reworks the requirements section of the manual as follows:
- some general rewording
- move configuration editor dependencies above the download tools, as this
is the first thing people come in contact with.
- move sentence regarding -dev packages to configuration editor dependencies
and restrict to 'libraries'.
- clarify the download tools part.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire at gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni at free-electrons.com>
docs/manual/prerequisite.txt | 40 ++++++++++++++++++++++------------------
1 files changed, 22 insertions(+), 18 deletions(-)
diff --git a/docs/manual/prerequisite.txt b/docs/manual/prerequisite.txt
index 30970d2..6ee01b4 100644
@@ -6,13 +6,11 @@
Buildroot is designed to run on Linux systems.
-Buildroot needs some software to be already installed on the host
-system; here are the lists of the mandatory and optional packages
-(package names may vary between distributions).
-Take care to _install both runtime and development data_, especially
-for the libraries that may be packaged in 2 distinct packages.
+While Buildroot itself will build most host packages it needs for the
+compilation, certain standard Linux utilities are expected to be
+already installed on the host system. Below you will find an overview of
+the mandatory and optional packages (note that package names may vary
@@ -45,14 +43,25 @@ for the libraries that may be packaged in 2 distinct packages.
=== Optional packages
-* Source fetching tools:
+* Configuration interface dependencies:
-In the official tree, most of the package sources are retrieved
-using +wget+; a few are only available through their +git+, +mercurial+,
-+svn+ or +cvs+ repository.
+For these libraries, you need to install both runtime and development
+data, which in many distributions are packaged separately. The
+development packages typically have a _-dev_ or _-devel_ suffix.
-All other source fetching methods are implemented and may be used in a
-development context (further details: refer to xref:download-infra).
+** +ncurses5+ to use the 'menuconfig' interface
+** +qt4+ to use the 'xconfig' interface
+** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
+* Source fetching tools:
+In the official tree, most of the package sources are retrieved using
++wget+ from _ftp_, _http_ or _https_ locations. A few packages are only
+available through a version control system. Moreover, Buildroot is
+capable of downloading sources via other tools, like +rsync+ or +scp+
+(refer to xref:download-infra for more details). If you enable
+packages using any of these methods, you will need to install the
+corresponding tool on the host system:
@@ -62,11 +71,6 @@ development context (further details: refer to xref:download-infra).
-* Configuration interface dependencies (requires development libraries):
-** +ncurses5+ to use the 'menuconfig' interface
-** +qt4+ to use the 'xconfig' interface
-** +glib2+, +gtk2+ and +glade2+ to use the 'gconfig' interface
* Java-related packages, if the Java Classpath needs to be built for
the target system:
** The +javac+ compiler
More information about the buildroot