All of lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas De Schampheleire <patrickdepinguin@gmail.com>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 5 of 8 RFCv2 for 2014.08] manual/getting started: rework 'System requirements' section
Date: Tue, 12 Aug 2014 22:20:10 +0200	[thread overview]
Message-ID: <dd6d42a03816c2c9bcd0.1407874810@localhost> (raw)
In-Reply-To: <patchbomb.1407874805@localhost>

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@gmail.com>

---
 docs/manual/prerequisite.txt |  40 +++++++++++++++++++----------------
 1 files changed, 22 insertions(+), 18 deletions(-)

diff -r 2f17e63e3fec -r dd6d42a03816 docs/manual/prerequisite.txt
--- a/docs/manual/prerequisite.txt	Thu Aug 07 18:10:10 2014 +0200
+++ b/docs/manual/prerequisite.txt	Tue Aug 12 20:09:13 2014 +0200
@@ -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
+between distributions).
 
 [[requirement-mandatory]]
 
@@ -45,14 +43,25 @@
 
 === Optional packages
 
+* Configuration interface dependencies:
++
+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.
++
+** +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+; a few are only available through their +git+, +mercurial+,
-+svn+ or +cvs+ repository.
-+
-All other source fetching methods are implemented and may be used in a
-development context (further details: refer to xref:download-infra[]).
+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:
 +
 ** +bazaar+
 ** +cvs+
@@ -62,11 +71,6 @@
 ** +scp+
 ** +subversion+
 
-* 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

  parent reply	other threads:[~2014-08-12 20:20 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-12 20:20 [Buildroot] [PATCH 0 of 8 RFCv2 for 2014.08] manual: restructuring and improvements Thomas De Schampheleire
2014-08-12 20:20 ` [Buildroot] [PATCH 1 of 8 RFCv2 for 2014.08] manual: high-level restructuring Thomas De Schampheleire
2014-08-12 20:20 ` [Buildroot] [PATCH 2 of 8 RFCv2 for 2014.08] manual: remove 'Events' section Thomas De Schampheleire
2014-08-12 20:20 ` [Buildroot] [PATCH 3 of 8 RFCv2 for 2014.08] manual/getting started: rename and move 'Getting involved' section Thomas De Schampheleire
2014-08-12 20:20 ` [Buildroot] [PATCH 4 of 8 RFCv2 for 2014.08] manual/getting started: rework 'Community resources' section Thomas De Schampheleire
2014-08-12 20:20 ` Thomas De Schampheleire [this message]
2014-08-12 20:20 ` [Buildroot] [PATCH 6 of 8 RFCv2 for 2014.08] website/download: update daily snapshot section Thomas De Schampheleire
2014-08-12 20:20 ` [Buildroot] [PATCH 7 of 8 RFCv2 for 2014.08] manual/getting started: rework 'Getting Buildroot' section Thomas De Schampheleire
2014-08-12 20:20 ` [Buildroot] [PATCH 8 of 8 RFCv2 for 2014.08] manual/getting started: rework 'Using " Thomas De Schampheleire
2014-08-15 20:52 ` [Buildroot] [PATCH 0 of 8 RFCv2 for 2014.08] manual: restructuring and improvements Samuel Martin
2014-08-17 19:13 ` Thomas Petazzoni

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=dd6d42a03816c2c9bcd0.1407874810@localhost \
    --to=patrickdepinguin@gmail.com \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.