From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from astoria.ccjclearline.com (astoria.ccjclearline.com [64.235.106.9]) by mail.openembedded.org (Postfix) with ESMTP id A1A646FEB6 for ; Sat, 21 Jun 2014 14:13:17 +0000 (UTC) Received: from [99.240.204.5] (port=41338 helo=crashcourse.ca) by astoria.ccjclearline.com with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.80) (envelope-from ) id 1WyM2f-0003ll-Ps for bitbake-devel@lists.openembedded.org; Sat, 21 Jun 2014 10:13:17 -0400 Date: Sat, 21 Jun 2014 10:09:33 -0400 (EDT) From: "Robert P. J. Day" X-X-Sender: rpjday@localhost To: BitBake developer list Message-ID: User-Agent: Alpine 2.11 (LFD 23 2013-08-11) MIME-Version: 1.0 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - astoria.ccjclearline.com X-AntiAbuse: Original Domain - lists.openembedded.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - crashcourse.ca X-Source: X-Source-Args: X-Source-Dir: Subject: [PATCH v2] bitbake-user-manual-execution.xml: Grammar/typo fixes. X-BeenThere: bitbake-devel@lists.openembedded.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: Patches and discussion that advance bitbake development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 21 Jun 2014 14:13:22 -0000 Content-Type: TEXT/PLAIN; charset=US-ASCII Collection of typo and grammar fixes from "Execution" chapter. Signed-off-by: Robert P. J. Day --- supersedes earlier patch submitted for this chapter; does not cover entire chapter, i'm still working on that. diff --git a/doc/bitbake-user-manual/bitbake-user-manual-execution.xml b/doc/bitbake-user-manual/bitbake-user-manual-execution.xml index 8514f23..d689d8a 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-execution.xml +++ b/doc/bitbake-user-manual/bitbake-user-manual-execution.xml @@ -6,8 +6,8 @@ The primary purpose for running BitBake is to produce some kind - of output such as an image, a kernel, or a software development - kit. + of output such as a single installable package, a kernel, a software + development kit, or even a full, board-specific bootable Linux image. Of course, you can execute the bitbake command with options that cause it to execute single tasks, compile single recipe files, capture or clear data, or simply @@ -29,11 +29,24 @@ - Prior to executing BitBake, you should take advantage of parallel - thread execution by setting the - BB_NUMBER_THREADS - variable in your local.conf - configuration file. + + Prior to executing BitBake, you should take advantage of available + parallel thread execution on your build host by setting the + BB_NUMBER_THREADS + variable in your project's local.conf + configuration file. + + + + A common way to determine this value for your build host is to run: + + $ grep processor /proc/cpuinfo + + and count the number of processors displayed. Note that the number of + processors will take into account hyper-threading, so that a quad-core + build host with hyper-threading will most likely show eight processors, + which is the value you would then assign to that variable. +
@@ -42,7 +55,7 @@ The first thing BitBake does is parse base configuration metadata. - Base configuration metadata consists of the + Base configuration metadata consists of your project's bblayers.conf file to determine what layers BitBake needs to recognize, all necessary layer.conf files (one from each layer), @@ -71,10 +84,11 @@ and BBFILES. BBPATH is used to search for - configuration and class files under - conf/ and class/ - directories, respectively. - BBFILES is used to find recipe files + configuration and class files under the + conf/ and classes/ + directories, respectively, while + BBFILES is used to locate both recipe + and recipe append files (.bb and .bbappend). If there is no bblayers.conf file, it is assumed the user has set the BBPATH @@ -82,7 +96,7 @@ - Next, the bitbake.conf file is searched + Next, the bitbake.conf file is located using the BBPATH variable that was just constructed. The bitbake.conf file may also include other @@ -117,18 +131,18 @@ optional conf/bblayers.conf configuration file. This file is expected to contain a BBLAYERS - variable that is a space delimited list of 'layer' directories. + variable that is a space-delimited list of 'layer' directories. Recall that if BitBake cannot find a bblayers.conf - file then it is assumed the user has set the BBPATH + file, then it is assumed the user has set the BBPATH and BBFILES directly in the environment. For each directory (layer) in this list, a conf/layer.conf - file is searched for and parsed with the + file is located and parsed with the LAYERDIR variable being set to the directory where the layer was found. - The idea is these files automatically setup + The idea is these files automatically set up BBPATH and other variables correctly for a given build directory. @@ -143,7 +157,7 @@ Only variable definitions and include directives are allowed - in .conf files. + in BitBake .conf files. Some variables directly influence BitBake's behavior. These variables might have been set from the environment depending on the environment variables previously @@ -166,9 +180,9 @@ Other classes that are specified in the configuration using the INHERIT variable are also included. - BitBake searches for class files in a "classes" subdirectory under - the paths in BBPATH in the same way as - configuration files. + BitBake searches for class files in a classes/ + subdirectory under the paths in BBPATH in the + same way as configuration files. @@ -189,7 +203,7 @@ If a recipe uses a closing curly brace within the function and the character has no leading spaces, BitBake produces a parsing error. - If you use a pair of curly brace in a shell function, the + If you use a pair of curly braces in a shell function, the closing curly brace must not be located at the start of the line without leading spaces. @@ -261,14 +275,14 @@ One common convention is to use the recipe filename to define pieces of metadata. For example, in bitbake.conf the recipe - name and version set + name and version are used to set the variables PN and PV: - PV = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE'),d)[1] or '1.0'}" PN = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE'),d)[0] or 'defaultpkgname'}" + PV = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE'),d)[1] or '1.0'}" - In this example, a recipe called "something_1.2.3.bb" sets + In this example, a recipe called "something_1.2.3.bb" would set PN to "something" and PV to "1.2.3". -- ======================================================================== Robert P. J. Day Ottawa, Ontario, CANADA http://crashcourse.ca Twitter: http://twitter.com/rpjday LinkedIn: http://ca.linkedin.com/in/rpjday ========================================================================