From 203aaaec084b80d0146b379d00527f8bd08b4119 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 16 Apr 2015 13:15:29 -0700 Subject: bitbake: bitbake-user-manual: Cleaned up parallelism note and formatted user input I updated the note in the second chapter that discusses the role for BB_NUMBER_THREADS. The updates make it a bit clearer. Also scrubbed the manual for instances of user-supplied values to check how they are being formatted. I fixed the formatting to use the tags so they are in italics. (Bitbake rev: e2879c60e905d7566091d40eab330372fa001313) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../bitbake-user-manual-execution.xml | 20 ++++++++++-------- .../bitbake-user-manual-fetching.xml | 24 ++++++++++++++-------- .../bitbake-user-manual-hello.xml | 2 +- .../bitbake-user-manual-metadata.xml | 6 +++--- .../bitbake-user-manual-ref-variables.xml | 12 +++++------ 5 files changed, 36 insertions(+), 28 deletions(-) (limited to 'bitbake/doc') diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml index 571424b99f..17a74591ac 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml @@ -21,7 +21,7 @@ The execution process is launched using the following command form: - $ bitbake <target> + $ bitbake target For information on the BitBake command and its options, see @@ -37,14 +37,16 @@ - A common way to determine this value for your build host is to run: + A common method to determine this value for your build host is to run + the following: $ 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. + This command returns the number of processors, which takes into + account hyper-threading. + Thus, a quad-core build host with hyper-threading most likely + shows eight processors, which is the value you would then assign to + BB_NUMBER_THREADS. @@ -782,13 +784,13 @@ make some dependency and hash information available to the build. This information includes: - BB_BASEHASH_task-<taskname>: + BB_BASEHASH_task-taskname: The base hashes for each task in the recipe. - BB_BASEHASH_<filename:taskname>: + BB_BASEHASH_filename:taskname: The base hashes for each dependent task. - BBHASHDEPS_<filename:taskname>: + BBHASHDEPS_filename:taskname: The task dependencies for each task. BB_TASKHASH: diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml index 21337208a1..2fb58e413e 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml @@ -157,8 +157,8 @@ SRC_URI variable with the appropriate varflags as follows: - SRC_URI[md5sum] = "value" - SRC_URI[sha256sum] = "value" + SRC_URI[md5sum] = "value" + SRC_URI[sha256sum] = "value" You can also specify the checksums as parameters on the SRC_URI as shown below: @@ -646,13 +646,19 @@ module: The module, which must include the - prepending "/" character, in the selected VOB - The module and vob - options are combined to create the following load rule in - the view config spec: - - load <vob><module> - + prepending "/" character, in the selected VOB. + + The module and vob + options are combined to create the load rule in + the view config spec. + As an example, consider the vob and + module values from the + SRC_URI statement at the start of this section. + Combining those values results in the following: + + load /example_vob/example_module + + proto: The protocol, which can be either http or diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml index fd5a92316c..f3628cf6ba 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml @@ -221,7 +221,7 @@ From your shell, enter the following commands to set and export the BBPATH variable: - $ BBPATH="<projectdirectory>" + $ BBPATH="projectdirectory" $ export BBPATH Use your actual project directory in the command. diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml index 0dafb03250..484b907518 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml @@ -952,7 +952,7 @@ The class needs to define the function as follows: - <classname>_<functionname> + classname_functionname For example, if you have a class file bar.bbclass and a function named @@ -966,7 +966,7 @@ The class needs to contain the EXPORT_FUNCTIONS statement as follows: - EXPORT_FUNCTIONS <functionname> + EXPORT_FUNCTIONS functionname For example, continuing with the same example, the statement in the bar.bbclass would be @@ -1164,7 +1164,7 @@ BitBake reads and writes varflags to the datastore using the following command forms: - <variable> = d.getVarFlags("<variable>") + variable = d.getVarFlags("variable") self.d.setVarFlags("FOO", {"func": True}) diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml index f5e5e61b1e..86bf30bb77 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml @@ -872,7 +872,7 @@ that run on the target MACHINE; "nativesdk", which targets the SDK machine instead of MACHINE; and "mulitlibs" in the form - "multilib:<multilib_name>". + "multilib:multilib_name". @@ -884,7 +884,7 @@ metadata: BBCLASSEXTEND =+ "native nativesdk" - BBCLASSEXTEND =+ "multilib:<multilib_name>" + BBCLASSEXTEND =+ "multilib:multilib_name" @@ -1091,9 +1091,9 @@ Set the variable as you would any environment variable and then run BitBake: - $ BBPATH="<build_directory>" + $ BBPATH="build_directory" $ export BBPATH - $ bitbake <target> + $ bitbake target @@ -1888,7 +1888,7 @@ Here is the general syntax to specify versions with the RDEPENDS variable: - RDEPENDS_${PN} = "<package> (<operator> <version>)" + RDEPENDS_${PN} = "package (operator version)" For operator, you can specify the following: @@ -1954,7 +1954,7 @@ Here is the general syntax to specify versions with the RRECOMMENDS variable: - RRECOMMENDS_${PN} = "<package> (<operator> <version>)" + RRECOMMENDS_${PN} = "package (operator version)" For operator, you can specify the following: -- cgit v1.2.3-54-g00ecf