* [PATCH 1/1] Fix some punctuation, wording, and caps in manual [not found] <AANLkTikY20mQoKfNaY6xsokcVabDnnaQKrvAmumBvv77@mail.gmail.com> @ 2011-06-03 16:14 ` Brandon Stafford 2011-06-07 21:55 ` Richard Purdie 0 siblings, 1 reply; 5+ messages in thread From: Brandon Stafford @ 2011-06-03 16:14 UTC (permalink / raw) To: bitbake-devel [-- Attachment #1: Type: text/plain, Size: 46822 bytes --] This patch contains what I hope are non-controversial improvements to the manual. Most of the changes are single characters, but the line-by-line diff makes the patch look large. This is my first patch to Bitbake, so please don't kill me immediately. (I originally sent this message, minus this sentence, around 2011-03-10, but the bitbake-dev list appeared to be silently dropping messages from 2011-03-07 until 2011-03-24. I resent it again on 2011-03-27. I'm now sending it to the post-migration bitbake-devel list on 2011-06-03.) Signed-off-by: Brandon Stafford <brandon@pingswept.org> --- doc/manual/usermanual.xml | 131 ++++++++++++++++++++++----------------------- 1 files changed, 65 insertions(+), 66 deletions(-) diff --git a/doc/manual/usermanual.xml b/doc/manual/usermanual.xml index 32b40ee..946a812 100644 --- a/doc/manual/usermanual.xml +++ b/doc/manual/usermanual.xml @@ -29,7 +29,7 @@ tasks and managing metadata. As such, its similarities to GNU make and other build tools are readily apparent. It was inspired by Portage, the package management system used by the Gentoo Linux distribution. BitBake is the basis of the <ulink url="http://www.openembedded.org/">OpenEmbedded</ulink> project, which is being used to build and maintain a number of embedded Linux distributions, including OpenZaurus and Familiar.</para> </section> <section> - <title>Background and Goals</title> + <title>Background and goals</title> <para>Prior to BitBake, no other build tool adequately met the needs of an aspiring embedded Linux distribution. All of the buildsystems used by traditional desktop Linux distributions lacked @@ -42,9 +42,9 @@ embedded space, were scalable or maintainable.</para> <listitem><para>Handle crosscompilation.</para></listitem> <listitem><para>Handle interpackage dependencies (build time on target architecture, build time on native architecture, and runtime).</para></listitem> <listitem><para>Support running any number of tasks within a given package, including, but not limited to, fetching upstream sources, unpacking them, patching them, configuring them, et cetera.</para></listitem> - <listitem><para>Must be linux distribution agnostic (both build and target).</para></listitem> + <listitem><para>Must be Linux distribution agnostic (both build and target).</para></listitem> <listitem><para>Must be architecture agnostic</para></listitem> - <listitem><para>Must support multiple build and target operating systems (including cygwin, the BSDs, etc).</para></listitem> + <listitem><para>Must support multiple build and target operating systems (including Cygwin, the BSDs, etc).</para></listitem> <listitem><para>Must be able to be self contained, rather than tightly integrated into the build machine's root filesystem.</para></listitem> <listitem><para>There must be a way to handle conditional metadata (on target architecture, operating system, distribution, machine).</para></listitem> <listitem><para>It must be easy for the person using the tools to supply their own local metadata and packages to operate against.</para></listitem> @@ -91,7 +91,7 @@ share common metadata between many packages.</para></listitem> <section> <title>Setting a default value (?=)</title> <para><screen><varname>A</varname> ?= "aval"</screen></para> - <para>If <varname>A</varname> is set before the above is called, it will retain it's previous value. If <varname>A</varname> is unset prior to the above call, <varname>A</varname> will be set to <literal>aval</literal>. Note that this assignment is immediate, so if there are multiple ?= assignments to a single variable, the first of those will be used.</para> + <para>If <varname>A</varname> is set before the above is called, it will retain its previous value. If <varname>A</varname> is unset prior to the above call, <varname>A</varname> will be set to <literal>aval</literal>. Note that this assignment is immediate, so if there are multiple ?= assignments to a single variable, the first of those will be used.</para> </section> <section> <title>Setting a default value (??=)</title> @@ -125,7 +125,7 @@ share common metadata between many packages.</para></listitem> <varname>B</varname> .= "additionaldata" <varname>C</varname> = "cval" <varname>C</varname> =. "test"</screen></para> - <para>In this example, <varname>B</varname> is now <literal>bvaladditionaldata</literal> and <varname>C</varname> is <literal>testcval</literal>. In contrast to the above Appending and Prepending operators no additional space + <para>In this example, <varname>B</varname> is now <literal>bvaladditionaldata</literal> and <varname>C</varname> is <literal>testcval</literal>. In contrast to the above appending and prepending operators, no additional space will be introduced.</para> </section> <section> @@ -147,12 +147,12 @@ will be introduced.</para> </section> <section> <title>Inclusion</title> - <para>Next, there is the <literal>include</literal> directive, which causes BitBake to parse in whatever file you specify, and insert it at that location, which is not unlike <command>make</command>. However, if the path specified on the <literal>include</literal> line is a relative path, BitBake will locate the first one it can find within <envar>BBPATH</envar>.</para> + <para>Next, there is the <literal>include</literal> directive, which causes BitBake to parse whatever file you specify, and insert it at that location, which is not unlike <command>make</command>. However, if the path specified on the <literal>include</literal> line is a relative path, BitBake will locate the first one it can find within <envar>BBPATH</envar>.</para> </section> <section> - <title>Requiring Inclusion</title> + <title>Requiring inclusion</title> <para>In contrast to the <literal>include</literal> directive, <literal>require</literal> will -raise an ParseError if the to be included file can not be found. Otherwise it will behave just like the <literal> +raise an ParseError if the file to be included cannot be found. Otherwise it will behave just like the <literal> include</literal> directive.</para> </section> <section> @@ -171,10 +171,10 @@ include</literal> directive.</para> import time print time.strftime('%Y%m%d', time.gmtime()) }</screen></para> - <para>This is the similar to the previous, but flags it as python so that BitBake knows it is python code.</para> + <para>This is the similar to the previous, but flags it as Python so that BitBake knows it is Python code.</para> </section> <section> - <title>Defining python functions into the global python namespace</title> + <title>Defining Python functions into the global Python namespace</title> <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para> <para><screen>def get_depends(bb, d): if bb.data.getVar('SOMECONDITION', d, True): @@ -187,8 +187,8 @@ include</literal> directive.</para> <para>This would result in <varname>DEPENDS</varname> containing <literal>dependencywithcond</literal>.</para> </section> <section> - <title>Variable Flags</title> - <para>Variables can have associated flags which provide a way of tagging extra information onto a variable. Several flags are used internally by bitbake but they can be used externally too if needed. The standard operations mentioned above also work on flags.</para> + <title>Variable flags</title> + <para>Variables can have associated flags which provide a way of tagging extra information onto a variable. Several flags are used internally by BitBake but they can be used externally too if needed. The standard operations mentioned above also work on flags.</para> <para><screen><varname>VARIABLE</varname>[<varname>SOMEFLAG</varname>] = "value"</screen></para> <para>In this example, <varname>VARIABLE</varname> has a flag, <varname>SOMEFLAG</varname> which is set to <literal>value</literal>.</para> </section> @@ -200,19 +200,19 @@ include</literal> directive.</para> <section> <title>Tasks</title> <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para> - <para>In BitBake, each step that needs to be run for a given .bb is known as a task. There is a command <literal>addtask</literal> to add new tasks (must be a defined python executable metadata and must start with <quote>do_</quote>) and describe intertask dependencies.</para> + <para>In BitBake, each step that needs to be run for a given .bb is known as a task. There is a command <literal>addtask</literal> to add new tasks (must be a defined Python executable metadata and must start with <quote>do_</quote>) and describe intertask dependencies.</para> <para><screen>python do_printdate () { import time print time.strftime('%Y%m%d', time.gmtime()) } addtask printdate before do_build</screen></para> - <para>This defines the necessary python function and adds it as a task which is now a dependency of do_build (the default task). If anyone executes the do_build task, that will result in do_printdate being run first.</para> + <para>This defines the necessary Python function and adds it as a task which is now a dependency of do_build, the default task. If anyone executes the do_build task, that will result in do_printdate being run first.</para> </section> <section> <title>Events</title> <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para> - <para>BitBake allows to install event handlers. Events are triggered at certain points during operation, such as, the beginning of operation against a given .bb, the start of a given task, task failure, task success, et cetera. The intent was to make it easy to do things like email notifications on build failure.</para> + <para>BitBake allows installation of event handlers. Events are triggered at certain points during operation, such as the beginning of operation against a given .bb, the start of a given task, task failure, task success, et cetera. The intent is to make it easy to do things like email notification on build failure.</para> <para><screen>addhandler myclass_eventhandler python myclass_eventhandler() { from bb.event import getName @@ -228,20 +228,20 @@ of the event and the content of the <varname>FILE</varname> variable.</para> </section> <section> <title>Variants</title> - <para>Two Bitbake features exist to facilitate the creation of multiple buildable incarnations from a single recipe file.</para> - <para>The first is <varname>BBCLASSEXTEND</varname>. This variable is a space separated list of classes to utilize to "extend" the recipe for each variant. As an example, setting <screen>BBCLASSEXTEND = "native"</screen> results in a second incarnation of the current recipe being available. This second incarantion will have the "native" class inherited.</para> - <para>The second feature is <varname>BBVERSIONS</varname>. This variable allows a single recipe to be able to build multiple versions of a project from a single recipe file, and allows you to specify conditional metadata (using the <varname>OVERRIDES</varname> mechanism) for a single version, or an optionally named range of versions:</para> + <para>Two BitBake features exist to facilitate the creation of multiple buildable incarnations from a single recipe file.</para> + <para>The first is <varname>BBCLASSEXTEND</varname>. This variable is a space separated list of classes used to "extend" the recipe for each variant. As an example, setting <screen>BBCLASSEXTEND = "native"</screen> results in a second incarnation of the current recipe being available. This second incarantion will have the "native" class inherited.</para> + <para>The second feature is <varname>BBVERSIONS</varname>. This variable allows a single recipe to build multiple versions of a project from a single recipe file, and allows you to specify conditional metadata (using the <varname>OVERRIDES</varname> mechanism) for a single version, or an optionally named range of versions:</para> <para><screen>BBVERSIONS = "1.0 2.0 git" SRC_URI_git = "git://someurl/somepath.git"</screen></para> <para><screen>BBVERSIONS = "1.0.[0-6]:1.0.0+ \ 1.0.[7-9]:1.0.7+" SRC_URI_append_1.0.7+ = "file://some_patch_which_the_new_versions_need.patch;patch=1"</screen></para> - <para>Note that the name of the range will default to the original version of the recipe, so given OE, a recipe file of foo_1.0.0+.bb will default the name of its versions to 1.0.0+. This is useful, as the range name is not only placed into overrides, it's also made available for the metadata to use in the form of the <varname>BPV</varname> variable, for use in file:// search paths (<varname>FILESPATH</varname>).</para> + <para>Note that the name of the range will default to the original version of the recipe, so given OE, a recipe file of foo_1.0.0+.bb will default the name of its versions to 1.0.0+. This is useful, as the range name is not only placed into overrides; it's also made available for the metadata to use in the form of the <varname>BPV</varname> variable, for use in file:// search paths (<varname>FILESPATH</varname>).</para> </section> </section> <section> - <title>Dependency Handling</title> - <para>Bitbake 1.7.x onwards works with the metadata at the task level since this is optimal when dealing with multiple threads of execution. A robust method of specifing task dependencies is therefore needed. </para> + <title>Dependency handling</title> + <para>BitBake 1.7.x onwards works with the metadata at the task level since this is optimal when dealing with multiple threads of execution. A robust method of specifing task dependencies is therefore needed. </para> <section> <title>Dependencies internal to the .bb file</title> <para>Where the dependencies are internal to a given .bb file, the dependencies are handled by the previously detailed addtask directive.</para> @@ -249,26 +249,26 @@ SRC_URI_append_1.0.7+ = "file://some_patch_which_the_new_versions_need.patch;pat <section> <title>DEPENDS</title> - <para>DEPENDS is taken to specify build time dependencies. The 'deptask' flag for tasks is used to signify the task of each DEPENDS which must have completed before that task can be executed.</para> + <para>DEPENDS lists build time dependencies. The 'deptask' flag for tasks is used to signify the task of each item listed in DEPENDS which must have completed before that task can be executed.</para> <para><screen>do_configure[deptask] = "do_populate_staging"</screen></para> <para>means the do_populate_staging task of each item in DEPENDS must have completed before do_configure can execute.</para> </section> <section> <title>RDEPENDS</title> - <para>RDEPENDS is taken to specify runtime dependencies. The 'rdeptask' flag for tasks is used to signify the task of each RDEPENDS which must have completed before that task can be executed.</para> + <para>RDEPENDS lists runtime dependencies. The 'rdeptask' flag for tasks is used to signify the task of each item listed in RDEPENDS which must have completed before that task can be executed.</para> <para><screen>do_package_write[rdeptask] = "do_package"</screen></para> <para>means the do_package task of each item in RDEPENDS must have completed before do_package_write can execute.</para> </section> <section> <title>Recursive DEPENDS</title> - <para>These are specified with the 'recdeptask' flag and is used signify the task(s) of each DEPENDS which must have completed before that task can be executed. It applies recursively so also, the DEPENDS of each item in the original DEPENDS must be met and so on.</para> + <para>These are specified with the 'recdeptask' flag and is used signify the task(s) of each DEPENDS which must have completed before that task can be executed. It applies recursively so the DEPENDS of each item in the original DEPENDS must be met and so on.</para> </section> <section> <title>Recursive RDEPENDS</title> - <para>These are specified with the 'recrdeptask' flag and is used signify the task(s) of each RDEPENDS which must have completed before that task can be executed. It applies recursively so also, the RDEPENDS of each item in the original RDEPENDS must be met and so on. It also runs all DEPENDS first too.</para> + <para>These are specified with the 'recrdeptask' flag and is used signify the task(s) of each RDEPENDS which must have completed before that task can be executed. It applies recursively so the RDEPENDS of each item in the original RDEPENDS must be met and so on. It also runs all DEPENDS first.</para> </section> <section> - <title>Inter Task</title> + <title>Inter task</title> <para>The 'depends' flag for tasks is a more generic form of which allows an interdependency on specific tasks rather than specifying the data in DEPENDS or RDEPENDS.</para> <para><screen>do_patch[depends] = "quilt-native:do_populate_staging"</screen></para> <para>means the do_populate_staging task of the target quilt-native must have completed before the do_patch can execute.</para> @@ -278,35 +278,34 @@ SRC_URI_append_1.0.7+ = "file://some_patch_which_the_new_versions_need.patch;pat <section> <title>Parsing</title> <section> - <title>Configuration Files</title> - <para>The first of the classifications of metadata in BitBake is configuration metadata. This metadata is global, and therefore affects <emphasis>all</emphasis> packages and tasks which are executed.</para> - <para>Bitbake will first search the current working directory for an optional "conf/bblayers.conf" configuration file. This file is expected to contain a BBLAYERS variable which is a space delimited list of 'layer' directories. For each directory in this list a "conf/layer.conf" file will be searched for and parsed with the LAYERDIR variable being set to the directory where the layer was found. The idea is these files will setup BBPATH and other variables correctly for a given build directory automatically for the user.</para> - <para>Bitbake will then expect to find 'conf/bitbake.conf' somewhere in the user specified <envar>BBPATH</envar>. That configuration file generally has include directives to pull in any other metadata (generally files specific to architecture, machine, <emphasis>local</emphasis> and so on.</para> + <title>Configuration files</title> + <para>The first kind of metadata in BitBake is configuration metadata. This metadata is global, and therefore affects <emphasis>all</emphasis> packages and tasks which are executed.</para> + <para>BitBake will first search the current working directory for an optional "conf/bblayers.conf" configuration file. This file is expected to contain a BBLAYERS variable which is a space delimited list of 'layer' directories. For each directory in this list, a "conf/layer.conf" file will be searched for and parsed with the LAYERDIR variable being set to the directory where the layer was found. The idea is these files will setup BBPATH and other variables correctly for a given build directory automatically for the user.</para> + <para>BitBake will then expect to find 'conf/bitbake.conf' somewhere in the user specified <envar>BBPATH</envar>. That configuration file generally has include directives to pull in any other metadata (generally files specific to architecture, machine, <emphasis>local</emphasis> and so on).</para> <para>Only variable definitions and include directives are allowed in .conf files.</para> </section> <section> <title>Classes</title> - <para>BitBake classes are our rudimentary inheritance mechanism. As briefly mentioned in the metadata introduction, they're parsed when an <literal>inherit</literal> directive is encountered, and they are located in classes/ relative to the dirs in <envar>BBPATH</envar>.</para> + <para>BitBake classes are our rudimentary inheritance mechanism. As briefly mentioned in the metadata introduction, they're parsed when an <literal>inherit</literal> directive is encountered, and they are located in classes/ relative to the directories in <envar>BBPATH</envar>.</para> </section> <section> - <title>.bb Files</title> + <title>.bb files</title> <para>A BitBake (.bb) file is a logical unit of tasks to be executed. Normally this is a package to be built. Inter-.bb dependencies are obeyed. The files themselves are located via the <varname>BBFILES</varname> variable, which is set to a space separated list of .bb files, and does handle wildcards.</para> </section> </section> </chapter> <chapter> - <title>File Download support</title> + <title>File download support</title> <section> <title>Overview</title> - <para>BitBake provides support to download files this procedure is called fetching. The SRC_URI is normally used to indicate BitBake which files to fetch. The next sections will describe th available fetchers and the options they have. Each Fetcher honors a set of Variables and -a per URI parameters separated by a <quote>;</quote> consisting of a key and a value. The semantic of the Variables and Parameters are defined by the Fetcher. BitBakes tries to have a consistent semantic between the different Fetchers. + <para>BitBake provides support to download files this procedure is called fetching. The SRC_URI is normally used to tell BitBake which files to fetch. The next sections will describe the available fetchers and their options. Each fetcher honors a set of variables and per URI parameters separated by a <quote>;</quote> consisting of a key and a value. The semantics of the variables and parameters are defined by the fetcher. BitBake tries to have consistent semantics between the different fetchers. </para> </section> <section> - <title>Local File Fetcher</title> - <para>The URN for the Local File Fetcher is <emphasis>file</emphasis>. The filename can be either absolute or relative. If the filename is relative <varname>FILESPATH</varname> and <varname>FILESDIR</varname> will be used to find the appropriate relative file depending on the <varname>OVERRIDES</varname>. Single files and complete directories can be specified. + <title>Local file fetcher</title> + <para>The URN for the local file fetcher is <emphasis>file</emphasis>. The filename can be either absolute or relative. If the filename is relative, <varname>FILESPATH</varname> and <varname>FILESDIR</varname> will be used to find the appropriate relative file, depending on the <varname>OVERRIDES</varname>. Single files and complete directories can be specified. <screen><varname>SRC_URI</varname>= "file://relativefile.patch" <varname>SRC_URI</varname>= "file://relativefile.patch;this=ignored" <varname>SRC_URI</varname>= "file:///Users/ich/very_important_software" @@ -315,10 +314,11 @@ a per URI parameters separated by a <quote>;</quote> consisting of a key and a v </section> <section> - <title>CVS File Fetcher</title> - <para>The URN for the CVS Fetcher is <emphasis>cvs</emphasis>. This Fetcher honors the variables <varname>DL_DIR</varname>, <varname>SRCDATE</varname>, <varname>FETCHCOMMAND_cvs</varname>, <varname>UPDATECOMMAND_cvs</varname>. <varname>DL_DIR</varname> specifies where a temporary checkout is saved, <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build), <varname>FETCHCOMMAND</varname> and <varname>UPDATECOMMAND</varname> specify which executables should be used when doing the CVS checkout or update. + <title>CVS file fetcher</title> + <para>The URN for the CVS fetcher is <emphasis>cvs</emphasis>. This fetcher honors the variables <varname>DL_DIR</varname>, <varname>SRCDATE</varname>, <varname>FETCHCOMMAND_cvs</varname>, <varname>UPDATECOMMAND_cvs</varname>. <varname>DL_DIR</varname> specifies where a temporary checkout is saved. <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). <varname>FETCHCOMMAND</varname> and <varname>UPDATECOMMAND</varname> specify which executables to use for the CVS checkout or update. </para> - <para>The supported Parameters are <varname>module</varname>, <varname>tag</varname>, <varname>date</varname>, <varname>method</varname>, <varname>localdir</varname>, <varname>rsh</varname> and <varname>scmdata</varname>. The <varname>module</varname> specifies which module to check out, the <varname>tag</varname> describes which CVS TAG should be used for the checkout. By default the TAG is empty. A <varname>date</varname> can be specified to override the SRCDATE of the configuration to checkout a specific date. The special value of "now" will cause the checkout to be updated on every build.<varname>method</varname> is by default <emphasis>pserver</emphasis>, if <emphasis>ext</emphasis> is used the <varname>rsh</varname> parameter will be evaluated and <varname>CVS_RSH</varname> will be set. Finally <varname>localdir</varname> is used to checkout into a special directory relative to <varname>CVSDIR</varname>. If <varname>scmdata</varname> is set to <quote>keep</quote> + <para>The supported parameters are <varname>module</varname>, <varname>tag</varname>, <varname>date</varname>, <varname>method</varname>, <varname>localdir</varname>, <varname>rsh</varname> and <varname>scmdata</varname>. The <varname>module</varname> specifies which module to check out, the <varname>tag</varname> describes which CVS TAG should be used for the checkout. By default the TAG is empty. A <varname>date</varname> can be specified to override the SRCDATE of the configuration to checkout a specific date. The special value of "now" will cause the checkout to be updated on every build.<varname>method</varname> is by default <emphasis>pserver</emphasis>. If <emphasis>ext</emphasis> is used the <varname>rsh</varname> parameter will be evaluated and <varname>CVS_RSH</varname> will be set. Finally, <varname>localdir</varname> is used to checkout into a special directory relative to <varname>CVSDIR</varname>. + <screen><varname>SRC_URI</varname> = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" <varname>SRC_URI</varname> = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat" </screen> @@ -326,11 +326,10 @@ a per URI parameters separated by a <quote>;</quote> consisting of a key and a v </section> <section> - <title>HTTP/FTP Fetcher</title> - <para>The URNs for the HTTP/FTP are <emphasis>http</emphasis>, <emphasis>https</emphasis> and <emphasis>ftp</emphasis>. This Fetcher honors the variables <varname>DL_DIR</varname>, <varname>FETCHCOMMAND_wget</varname>, <varname>PREMIRRORS</varname>, <varname>MIRRORS</varname>. The <varname>DL_DIR</varname> defines where to store the fetched file, <varname>FETCHCOMMAND</varname> contains the command used for fetching. <quote>${URI}</quote> and <quote>${FILES}</quote> will be replaced by the uri and basename of the to be fetched file. <varname>PREMIRRORS</varname> -will be tried first when fetching a file if that fails the actual file will be tried and finally all <varname>MIRRORS</varname> will be tried. + <title>HTTP/FTP fetcher</title> + <para>The URNs for the HTTP/FTP fetcher are <emphasis>http</emphasis>, <emphasis>https</emphasis> and <emphasis>ftp</emphasis>. This fetcher honors the variables <varname>DL_DIR</varname>, <varname>FETCHCOMMAND_wget</varname>, <varname>PREMIRRORS</varname>, <varname>MIRRORS</varname>. The <varname>DL_DIR</varname> defines where to store the fetched file. <varname>FETCHCOMMAND</varname> contains the command used for fetching. <quote>${URI}</quote> and <quote>${FILES}</quote> will be replaced by the URI and basename of the file to be fetched. <varname>PREMIRRORS</varname> will be tried first when fetching a file. If that fails, the actual file will be tried and finally all <varname>MIRRORS</varname> will be tried. </para> - <para>The only supported Parameter is <varname>md5sum</varname>. After a fetch the <varname>md5sum</varname> of the file will be calculated and the two sums will be compared. + <para>The only supported parameter is <varname>md5sum</varname>. After a fetch the <varname>md5sum</varname> of the file will be calculated and the two sums will be compared. </para> <para><screen><varname>SRC_URI</varname> = " http://oe.handhelds.org/not_there.aac;md5sum=12343" <varname>SRC_URI</varname> = " ftp://oe.handhelds.org/not_there_as_well.aac;md5sum=1234" @@ -339,19 +338,19 @@ will be tried first when fetching a file if that fails the actual file will be t </section> <section> - <title>SVK Fetcher</title> + <title>SVK fetcher</title> <para> <emphasis>Currently NOT supported</emphasis> </para> </section> <section> - <title>SVN Fetcher</title> - <para>The URN for the SVN Fetcher is <emphasis>svn</emphasis>. + <title>SVN fetcher</title> + <para>The URN for the SVN fetcher is <emphasis>svn</emphasis>. </para> - <para>This Fetcher honors the variables <varname>FETCHCOMMAND_svn</varname>, <varname>DL_DIR</varname>, <varname>SRCDATE</varname>. <varname>FETCHCOMMAND</varname> contains the subversion command, <varname>DL_DIR</varname> is the directory where tarballs will be saved, <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). + <para>This fetcher honors the variables <varname>FETCHCOMMAND_svn</varname>, <varname>DL_DIR</varname>, <varname>SRCDATE</varname>. <varname>FETCHCOMMAND</varname> contains the subversion command. <varname>DL_DIR</varname> is the directory where tarballs will be saved. <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). </para> - <para>The supported Parameters are <varname>proto</varname>, <varname>rev</varname> and <varname>scmdata</varname>. <varname>proto</varname> is the subversion protocol, <varname>rev</varname> is the subversion revision. If <varname>scmdata</varname> is set to <quote>keep</quote>, the <quote>.svn</quote> directories will be available during compile-time. + <para>The supported parameters are <varname>proto</varname>, <varname>rev</varname> and <varname>scmdata</varname>. <varname>proto</varname> is the Subversion protocol, <varname>rev</varname> is the Subversion revision. If <varname>scmdata</varname> is set to <quote>keep</quote>, the <quote>.svn</quote> directories will be available during compile-time. </para> <para><screen><varname>SRC_URI</varname> = "svn:// svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667" <varname>SRC_URI</varname> = "svn:// svn.oe.handhelds.org/svn/;module=opie;proto=svn+ssh;date=20060126" @@ -359,12 +358,12 @@ will be tried first when fetching a file if that fails the actual file will be t </section> <section> - <title>GIT Fetcher</title> + <title>GIT fetcher</title> <para>The URN for the GIT Fetcher is <emphasis>git</emphasis>. </para> <para>The Variables <varname>DL_DIR</varname>, <varname>GITDIR</varname> are used. <varname>DL_DIR</varname> will be used to store the checkedout version. <varname>GITDIR</varname> will be used as the base directory where the git tree is cloned to. </para> - <para>The Parameters are <emphasis>tag</emphasis>, <emphasis>protocol</emphasis> and <emphasis>scmdata</emphasis>. <emphasis>tag</emphasis> is a git tag, the default is <quote>master</quote>. <emphasis>protocol</emphasis> is the git protocol to use and defaults to <quote>rsync</quote>. If <emphasis>scmdata</emphasis> is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available during compile-time. + <para>The parameters are <emphasis>tag</emphasis>, <emphasis>protocol</emphasis> and <emphasis>scmdata</emphasis>. <emphasis>tag</emphasis> is a Git tag, the default is <quote>master</quote>. <emphasis>protocol</emphasis> is the Git protocol to use and defaults to <quote>rsync</quote>. If <emphasis>scmdata</emphasis> is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available during compile-time. </para> <para><screen><varname>SRC_URI</varname> = "git:// git.oe.handhelds.org/git/vip.git;tag=version-1" <varname>SRC_URI</varname> = "git:// git.oe.handhelds.org/git/vip.git;protocol=http" @@ -375,13 +374,13 @@ will be tried first when fetching a file if that fails the actual file will be t <chapter> - <title>The bitbake command</title> + <title>The BitBake command</title> <section> <title>Introduction</title> <para>bitbake is the primary command in the system. It facilitates executing tasks in a single .bb file, or executing a given task on a set of multiple .bb files, accounting for interdependencies amongst them.</para> </section> <section> - <title>Usage and Syntax</title> + <title>Usage and syntax</title> <para> <screen><prompt>$ </prompt>bitbake --help usage: bitbake [options] [package ...] @@ -438,7 +437,7 @@ options: <para> <example> <title>Executing a task against a single .bb</title> - <para>Executing tasks for a single file is relatively simple. You specify the file in question, and bitbake parses it and executes the specified task (or <quote>build</quote> by default). It obeys intertask dependencies when doing so.</para> + <para>Executing tasks for a single file is relatively simple. You specify the file in question, and BitBake parses it and executes the specified task (or <quote>build</quote> by default). It obeys intertask dependencies when doing so.</para> <para><quote>clean</quote> task:</para> <para><screen><prompt>$ </prompt>bitbake -b blah_1.0.bb -c clean</screen></para> <para><quote>build</quote> task:</para> @@ -448,8 +447,8 @@ options: <para> <example> <title>Executing tasks against a set of .bb files</title> - <para>There are a number of additional complexities introduced when one wants to manage multiple .bb files. Clearly there needs to be a way to tell bitbake what files are available, and of those, which we want to execute at this time. There also needs to be a way for each .bb to express its dependencies, both for build time and runtime. There must be a way for the user to express their preferences when multiple .bb's provide the same functionality, or when there are multiple versions of a .bb.</para> - <para>The next section, Metadata, outlines how one goes about specifying such things.</para> + <para>There are a number of additional complexities introduced when one wants to manage multiple .bb files. Clearly there needs to be a way to tell BitBake what files are available, and of those, which we want to execute at this time. There also needs to be a way for each .bb to express its dependencies, both for build time and runtime. There must be a way for the user to express their preferences when multiple .bb's provide the same functionality, or when there are multiple versions of a .bb.</para> + <para>The next section, Metadata, outlines how to specify such things.</para> <para>Note that the bitbake command, when not using --buildfile, accepts a <varname>PROVIDER</varname>, not a filename or anything else. By default, a .bb generally PROVIDES its packagename, packagename-version, and packagename-version-revision.</para> <screen><prompt>$ </prompt>bitbake blah</screen> <screen><prompt>$ </prompt>bitbake blah-1.0</screen> @@ -461,8 +460,8 @@ options: <example> <title>Generating dependency graphs</title> <para>BitBake is able to generate dependency graphs using the dot syntax. These graphs can be converted -to images using the <application>dot</application> application from <ulink url="http://www.graphviz.org">graphviz</ulink>. -Two files will be written into the current working directory, <emphasis>depends.dot</emphasis> containing dependency information at the package level and <emphasis>task-depends.dot</emphasis> containing a breakdown of the dependencies at the task level. To stop depending on common depends one can use the <prompt>-I depend</prompt> to omit these from the graph. This can lead to more readable graphs. E.g. this way <varname>DEPENDS</varname> from inherited classes, e.g. base.bbclass, can be removed from the graph.</para> +to images using the <application>dot</application> application from <ulink url="http://www.graphviz.org">Graphviz</ulink>. +Two files will be written into the current working directory, <emphasis>depends.dot</emphasis> containing dependency information at the package level and <emphasis>task-depends.dot</emphasis> containing a breakdown of the dependencies at the task level. To stop depending on common depends, one can use the <prompt>-I depend</prompt> to omit these from the graph. This can lead to more readable graphs. This way, <varname>DEPENDS</varname> from inherited classes such as base.bbclass can be removed from the graph.</para> <screen><prompt>$ </prompt>bitbake -g blah</screen> <screen><prompt>$ </prompt>bitbake -g -I virtual/whatever -I bloom blah</screen> </example> @@ -470,20 +469,20 @@ Two files will be written into the current working directory, <emphasis>depends. </section> <section> <title>Special variables</title> - <para>Certain variables affect bitbake operation:</para> + <para>Certain variables affect BitBake operation:</para> <section> <title><varname>BB_NUMBER_THREADS</varname></title> - <para> The number of threads bitbake should run at once (default: 1).</para> + <para> The number of threads BitBake should run at once (default: 1).</para> </section> </section> <section> <title>Metadata</title> - <para>As you may have seen in the usage information, or in the information about .bb files, the BBFILES variable is how the bitbake tool locates its files. This variable is a space separated list of files that are available, and supports wildcards. + <para>As you may have seen in the usage information, or in the information about .bb files, the <varname>BBFILES</varname> variable is how the BitBake tool locates its files. This variable is a space separated list of files that are available, and supports wildcards. <example> <title>Setting BBFILES</title> <programlisting><varname>BBFILES</varname> = "/path/to/bbfiles/*.bb"</programlisting> </example></para> - <para>With regard to dependencies, it expects the .bb to define a <varname>DEPENDS</varname> variable, which contains a space separated list of <quote>package names</quote>, which themselves are the <varname>PN</varname> variable. The <varname>PN</varname> variable is, in general, by default, set to a component of the .bb filename.</para> + <para>With regard to dependencies, it expects the .bb to define a <varname>DEPENDS</varname> variable, which contains a space separated list of <quote>package names</quote>, which themselves are the <varname>PN</varname> variable. The <varname>PN</varname> variable is, in general, set to a component of the .bb filename by default.</para> <example> <title>Depending on another .bb</title> <para>a.bb: @@ -496,7 +495,7 @@ DEPENDS += "package-b"</screen> </example> <example> <title>Using PROVIDES</title> - <para>This example shows the usage of the PROVIDES variable, which allows a given .bb to specify what functionality it provides.</para> + <para>This example shows the usage of the <varname>PROVIDES</varname> variable, which allows a given .bb to specify what functionality it provides.</para> <para>package1.bb: <screen>PROVIDES += "virtual/package"</screen> </para> @@ -506,16 +505,16 @@ DEPENDS += "package-b"</screen> <para>package3.bb: <screen>PROVIDES += "virtual/package"</screen> </para> - <para>As you can see, here there are two different .bb's that provide the same functionality (virtual/package). Clearly, there needs to be a way for the person running bitbake to control which of those providers gets used. There is, indeed, such a way.</para> + <para>As you can see, we have two different .bb's that provide the same functionality (virtual/package). Clearly, there needs to be a way for the person running BitBake to control which of those providers gets used. There is, indeed, such a way.</para> <para>The following would go into a .conf file, to select package1: <screen>PREFERRED_PROVIDER_virtual/package = "package1"</screen> </para> </example> <example> <title>Specifying version preference</title> - <para>When there are multiple <quote>versions</quote> of a given package, bitbake defaults to selecting the most recent version, unless otherwise specified. If the .bb in question has a <varname>DEFAULT_PREFERENCE</varname> set lower than the other .bb's (default is 0), then it will not be selected. This allows the person or persons maintaining the repository of .bb files to specify their preferences for the default selected version. In addition, the user can specify their preferences with regard to version.</para> + <para>When there are multiple <quote>versions</quote> of a given package, BitBake defaults to selecting the most recent version, unless otherwise specified. If the .bb in question has a <varname>DEFAULT_PREFERENCE</varname> set lower than the other .bb's (default is 0), then it will not be selected. This allows the person or persons maintaining the repository of .bb files to specify their preference for the default selected version. In addition, the user can specify their preferred version.</para> <para>If the first .bb is named <filename>a_1.1.bb</filename>, then the <varname>PN</varname> variable will be set to <quote>a</quote>, and the <varname>PV</varname> variable will be set to 1.1.</para> - <para>If we then have an <filename>a_1.2.bb </filename>, bitbake will choose 1.2 by default. However, if we define the following variable in a .conf that bitbake parses, we can change that. + <para>If we then have an <filename>a_1.2.bb </filename>, BitBake will choose 1.2 by default. However, if we define the following variable in a .conf that BitBake parses, we can change that. <screen>PREFERRED_VERSION_a = "1.1"</screen> </para> </example> -- 1.7.1 [-- Attachment #2: Type: text/html, Size: 64511 bytes --] ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 1/1] Fix some punctuation, wording, and caps in manual 2011-06-03 16:14 ` [PATCH 1/1] Fix some punctuation, wording, and caps in manual Brandon Stafford @ 2011-06-07 21:55 ` Richard Purdie 2011-06-07 23:07 ` Brandon Stafford 0 siblings, 1 reply; 5+ messages in thread From: Richard Purdie @ 2011-06-07 21:55 UTC (permalink / raw) To: Brandon Stafford; +Cc: bitbake-devel Hi Brandon, On Fri, 2011-06-03 at 12:14 -0400, Brandon Stafford wrote: > This patch contains what I hope are non-controversial improvements to > the manual. Most of the changes are single characters, but the > line-by-line diff makes the patch look large. > > This is my first patch to Bitbake, so please don't kill me > immediately. (I originally sent this message, minus this sentence, > around 2011-03-10, but the bitbake-dev list appeared to be silently > dropping messages from 2011-03-07 until 2011-03-24. I resent it again > on 2011-03-27. I'm now sending it to the post-migration bitbake-devel > list on 2011-06-03.) > > Signed-off-by: Brandon Stafford <brandon@pingswept.org> I tried to get this to apply but the patch appears corrupt and I can't convince the patch tools to accept it. It looks like you sent html email and that your mailer line wrapped the text in some way too. Perhaps you could resend the patch as an attachment to the email or alternatively don't send html emails and try and address the line wrapping problem. Cheers, Richard ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 1/1] Fix some punctuation, wording, and caps in manual 2011-06-07 21:55 ` Richard Purdie @ 2011-06-07 23:07 ` Brandon Stafford 2011-06-22 13:38 ` Paul Eggleton 2011-06-22 15:31 ` Richard Purdie 0 siblings, 2 replies; 5+ messages in thread From: Brandon Stafford @ 2011-06-07 23:07 UTC (permalink / raw) To: bitbake-devel [-- Attachment #1: Type: text/plain, Size: 1344 bytes --] On Tue, Jun 7, 2011 at 5:55 PM, Richard Purdie <richard.purdie@linuxfoundation.org> wrote: > > Hi Brandon, > > On Fri, 2011-06-03 at 12:14 -0400, Brandon Stafford wrote: > > This patch contains what I hope are non-controversial improvements to > > the manual. Most of the changes are single characters, but the > > line-by-line diff makes the patch look large. > > > > This is my first patch to Bitbake, so please don't kill me > > immediately. (I originally sent this message, minus this sentence, > > around 2011-03-10, but the bitbake-dev list appeared to be silently > > dropping messages from 2011-03-07 until 2011-03-24. I resent it again > > on 2011-03-27. I'm now sending it to the post-migration bitbake-devel > > list on 2011-06-03.) > > > > Signed-off-by: Brandon Stafford <brandon@pingswept.org> > > I tried to get this to apply but the patch appears corrupt and I can't > convince the patch tools to accept it. It looks like you sent html email > and that your mailer line wrapped the text in some way too. > Revised patch and retested against current HEAD (commit 077657e50ad032c0fa876bf54e9802af2686e0fb). Now works for me with: patch -p1 < Revised-fixes-to-punctuation-wording-and-caps-in-manual.patch I'm sending the patch as an attachment; we'll see if that produces more success. Brandon [-- Attachment #2: Revised-fixes-to-punctuation-wording-and-caps-in-manual.patch --] [-- Type: application/octet-stream, Size: 45305 bytes --] --- a/doc/manual/usermanual.xml +++ b/doc/manual/usermanual.xml @@ -29,7 +29,7 @@ build tools are readily apparent. It was inspired by Portage, the package management system used by the Gentoo Linux distribution. BitBake is the basis of the <ulink url="http://www.openembedded.org/">OpenEmbedded</ulink> project, which is being used to build and maintain a number of embedded Linux distributions, including OpenZaurus and Familiar.</para> </section> <section> - <title>Background and Goals</title> + <title>Background and goals</title> <para>Prior to BitBake, no other build tool adequately met the needs of an aspiring embedded Linux distribution. All of the buildsystems used by traditional desktop Linux distributions lacked @@ -42,9 +42,9 @@ <listitem><para>Handle crosscompilation.</para></listitem> <listitem><para>Handle interpackage dependencies (build time on target architecture, build time on native architecture, and runtime).</para></listitem> <listitem><para>Support running any number of tasks within a given package, including, but not limited to, fetching upstream sources, unpacking them, patching them, configuring them, et cetera.</para></listitem> - <listitem><para>Must be linux distribution agnostic (both build and target).</para></listitem> + <listitem><para>Must be Linux distribution agnostic (both build and target).</para></listitem> <listitem><para>Must be architecture agnostic</para></listitem> - <listitem><para>Must support multiple build and target operating systems (including cygwin, the BSDs, etc).</para></listitem> + <listitem><para>Must support multiple build and target operating systems (including Cygwin, the BSDs, etc).</para></listitem> <listitem><para>Must be able to be self contained, rather than tightly integrated into the build machine's root filesystem.</para></listitem> <listitem><para>There must be a way to handle conditional metadata (on target architecture, operating system, distribution, machine).</para></listitem> <listitem><para>It must be easy for the person using the tools to supply their own local metadata and packages to operate against.</para></listitem> @@ -91,13 +91,13 @@ <section> <title>Setting a default value (?=)</title> <para><screen><varname>A</varname> ?= "aval"</screen></para> - <para>If <varname>A</varname> is set before the above is called, it will retain it's previous value. If <varname>A</varname> is unset prior to the above call, <varname>A</varname> will be set to <literal>aval</literal>. Note that this assignment is immediate, so if there are multiple ?= assignments to a single variable, the first of those will be used.</para> + <para>If <varname>A</varname> is set before the above is called, it will retain its previous value. If <varname>A</varname> is unset prior to the above call, <varname>A</varname> will be set to <literal>aval</literal>. Note that this assignment is immediate, so if there are multiple ?= assignments to a single variable, the first of those will be used.</para> </section> <section> <title>Setting a default value (??=)</title> <para><screen><varname>A</varname> ??= "somevalue"</screen></para> <para><screen><varname>A</varname> ??= "someothervalue"</screen></para> - <para>If <varname>A</varname> is set before the above, it will retain that value. If <varname>A</varname> is unset prior to the above, <varname>A</varname> will be set to <literal>someothervalue</literal>. This is a lazy version of ?=, in that the assignment does not occur until the end of the parsing process, so that the last, rather than the first, ??= assignment to a given variable will be used.</para> + <para>If <varname>A</varname> is set before the above, it will retain that value. If <varname>A</varname> is unset prior to the above, <varname>A</varname> will be set to <literal>someothervalue</literal>. This is a lazy version of ??=, in that the assignment does not occur until the end of the parsing process, so that the last, rather than the first, ??= assignment to a given variable will be used.</para> </section> <section> <title>Immediate variable expansion (:=)</title> @@ -125,7 +125,7 @@ <varname>B</varname> .= "additionaldata" <varname>C</varname> = "cval" <varname>C</varname> =. "test"</screen></para> - <para>In this example, <varname>B</varname> is now <literal>bvaladditionaldata</literal> and <varname>C</varname> is <literal>testcval</literal>. In contrast to the above Appending and Prepending operators no additional space + <para>In this example, <varname>B</varname> is now <literal>bvaladditionaldata</literal> and <varname>C</varname> is <literal>testcval</literal>. In contrast to the above appending and prepending operators, no additional space will be introduced.</para> </section> <section> @@ -147,12 +147,12 @@ </section> <section> <title>Inclusion</title> - <para>Next, there is the <literal>include</literal> directive, which causes BitBake to parse in whatever file you specify, and insert it at that location, which is not unlike <command>make</command>. However, if the path specified on the <literal>include</literal> line is a relative path, BitBake will locate the first one it can find within <envar>BBPATH</envar>.</para> + <para>Next, there is the <literal>include</literal> directive, which causes BitBake to parse whatever file you specify, and insert it at that location, which is not unlike <command>make</command>. However, if the path specified on the <literal>include</literal> line is a relative path, BitBake will locate the first one it can find within <envar>BBPATH</envar>.</para> </section> <section> - <title>Requiring Inclusion</title> + <title>Requiring inclusion</title> <para>In contrast to the <literal>include</literal> directive, <literal>require</literal> will -raise an ParseError if the to be included file can not be found. Otherwise it will behave just like the <literal> +raise an ParseError if the file to be included cannot be found. Otherwise it will behave just like the <literal> include</literal> directive.</para> </section> <section> @@ -171,10 +171,10 @@ import time print time.strftime('%Y%m%d', time.gmtime()) }</screen></para> - <para>This is the similar to the previous, but flags it as python so that BitBake knows it is python code.</para> + <para>This is the similar to the previous, but flags it as Python so that BitBake knows it is Python code.</para> </section> <section> - <title>Defining python functions into the global python namespace</title> + <title>Defining Python functions into the global Python namespace</title> <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para> <para><screen>def get_depends(bb, d): if bb.data.getVar('SOMECONDITION', d, True): @@ -187,8 +187,8 @@ <para>This would result in <varname>DEPENDS</varname> containing <literal>dependencywithcond</literal>.</para> </section> <section> - <title>Variable Flags</title> - <para>Variables can have associated flags which provide a way of tagging extra information onto a variable. Several flags are used internally by bitbake but they can be used externally too if needed. The standard operations mentioned above also work on flags.</para> + <title>Variable flags</title> + <para>Variables can have associated flags which provide a way of tagging extra information onto a variable. Several flags are used internally by BitBake but they can be used externally too if needed. The standard operations mentioned above also work on flags.</para> <para><screen><varname>VARIABLE</varname>[<varname>SOMEFLAG</varname>] = "value"</screen></para> <para>In this example, <varname>VARIABLE</varname> has a flag, <varname>SOMEFLAG</varname> which is set to <literal>value</literal>.</para> </section> @@ -200,19 +200,19 @@ <section> <title>Tasks</title> <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para> - <para>In BitBake, each step that needs to be run for a given .bb is known as a task. There is a command <literal>addtask</literal> to add new tasks (must be a defined python executable metadata and must start with <quote>do_</quote>) and describe intertask dependencies.</para> + <para>In BitBake, each step that needs to be run for a given .bb is known as a task. There is a command <literal>addtask</literal> to add new tasks (must be a defined Python executable metadata and must start with <quote>do_</quote>) and describe intertask dependencies.</para> <para><screen>python do_printdate () { import time print time.strftime('%Y%m%d', time.gmtime()) } addtask printdate before do_build</screen></para> - <para>This defines the necessary python function and adds it as a task which is now a dependency of do_build (the default task). If anyone executes the do_build task, that will result in do_printdate being run first.</para> + <para>This defines the necessary Python function and adds it as a task which is now a dependency of do_build, the default task. If anyone executes the do_build task, that will result in do_printdate being run first.</para> </section> <section> <title>Events</title> <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para> - <para>BitBake allows to install event handlers. Events are triggered at certain points during operation, such as, the beginning of operation against a given .bb, the start of a given task, task failure, task success, et cetera. The intent was to make it easy to do things like email notifications on build failure.</para> + <para>BitBake allows installation of event handlers. Events are triggered at certain points during operation, such as the beginning of operation against a given .bb, the start of a given task, task failure, task success, et cetera. The intent is to make it easy to do things like email notification on build failure.</para> <para><screen>addhandler myclass_eventhandler python myclass_eventhandler() { from bb.event import getName @@ -228,20 +228,20 @@ </section> <section> <title>Variants</title> - <para>Two Bitbake features exist to facilitate the creation of multiple buildable incarnations from a single recipe file.</para> - <para>The first is <varname>BBCLASSEXTEND</varname>. This variable is a space separated list of classes to utilize to "extend" the recipe for each variant. As an example, setting <screen>BBCLASSEXTEND = "native"</screen> results in a second incarnation of the current recipe being available. This second incarantion will have the "native" class inherited.</para> - <para>The second feature is <varname>BBVERSIONS</varname>. This variable allows a single recipe to be able to build multiple versions of a project from a single recipe file, and allows you to specify conditional metadata (using the <varname>OVERRIDES</varname> mechanism) for a single version, or an optionally named range of versions:</para> + <para>Two BitBake features exist to facilitate the creation of multiple buildable incarnations from a single recipe file.</para> + <para>The first is <varname>BBCLASSEXTEND</varname>. This variable is a space separated list of classes used to "extend" the recipe for each variant. As an example, setting <screen>BBCLASSEXTEND = "native"</screen> results in a second incarnation of the current recipe being available. This second incarantion will have the "native" class inherited.</para> + <para>The second feature is <varname>BBVERSIONS</varname>. This variable allows a single recipe to build multiple versions of a project from a single recipe file, and allows you to specify conditional metadata (using the <varname>OVERRIDES</varname> mechanism) for a single version, or an optionally named range of versions:</para> <para><screen>BBVERSIONS = "1.0 2.0 git" SRC_URI_git = "git://someurl/somepath.git"</screen></para> <para><screen>BBVERSIONS = "1.0.[0-6]:1.0.0+ \ 1.0.[7-9]:1.0.7+" SRC_URI_append_1.0.7+ = "file://some_patch_which_the_new_versions_need.patch;patch=1"</screen></para> - <para>Note that the name of the range will default to the original version of the recipe, so given OE, a recipe file of foo_1.0.0+.bb will default the name of its versions to 1.0.0+. This is useful, as the range name is not only placed into overrides, it's also made available for the metadata to use in the form of the <varname>BPV</varname> variable, for use in file:// search paths (<varname>FILESPATH</varname>).</para> + <para>Note that the name of the range will default to the original version of the recipe, so given OE, a recipe file of foo_1.0.0+.bb will default the name of its versions to 1.0.0+. This is useful, as the range name is not only placed into overrides; it's also made available for the metadata to use in the form of the <varname>BPV</varname> variable, for use in file:// search paths (<varname>FILESPATH</varname>).</para> </section> </section> <section> - <title>Dependency Handling</title> - <para>Bitbake 1.7.x onwards works with the metadata at the task level since this is optimal when dealing with multiple threads of execution. A robust method of specifing task dependencies is therefore needed. </para> + <title>Dependency handling</title> + <para>BitBake 1.7.x onwards works with the metadata at the task level since this is optimal when dealing with multiple threads of execution. A robust method of specifing task dependencies is therefore needed. </para> <section> <title>Dependencies internal to the .bb file</title> <para>Where the dependencies are internal to a given .bb file, the dependencies are handled by the previously detailed addtask directive.</para> @@ -249,26 +249,26 @@ <section> <title>DEPENDS</title> - <para>DEPENDS is taken to specify build time dependencies. The 'deptask' flag for tasks is used to signify the task of each DEPENDS which must have completed before that task can be executed.</para> + <para>DEPENDS lists build time dependencies. The 'deptask' flag for tasks is used to signify the task of each item listed in DEPENDS which must have completed before that task can be executed.</para> <para><screen>do_configure[deptask] = "do_populate_staging"</screen></para> <para>means the do_populate_staging task of each item in DEPENDS must have completed before do_configure can execute.</para> </section> <section> <title>RDEPENDS</title> - <para>RDEPENDS is taken to specify runtime dependencies. The 'rdeptask' flag for tasks is used to signify the task of each RDEPENDS which must have completed before that task can be executed.</para> + <para>RDEPENDS lists runtime dependencies. The 'rdeptask' flag for tasks is used to signify the task of each item listed in RDEPENDS which must have completed before that task can be executed.</para> <para><screen>do_package_write[rdeptask] = "do_package"</screen></para> <para>means the do_package task of each item in RDEPENDS must have completed before do_package_write can execute.</para> </section> <section> <title>Recursive DEPENDS</title> - <para>These are specified with the 'recdeptask' flag and is used to signify the task(s) of each DEPENDS which must have completed before that task can be executed. It applies recursively so also, the DEPENDS of each item in the original DEPENDS must be met and so on.</para> + <para>These are specified with the 'recdeptask' flag and is used signify the task(s) of each DEPENDS which must have completed before that task can be executed. It applies recursively so the DEPENDS of each item in the original DEPENDS must be met and so on.</para> </section> <section> <title>Recursive RDEPENDS</title> - <para>These are specified with the 'recrdeptask' flag and is used to signify the task(s) of each RDEPENDS which must have completed before that task can be executed. It applies recursively so also, the RDEPENDS of each item in the original RDEPENDS must be met and so on. It also runs all DEPENDS first too.</para> + <para>These are specified with the 'recrdeptask' flag and is used signify the task(s) of each RDEPENDS which must have completed before that task can be executed. It applies recursively so the RDEPENDS of each item in the original RDEPENDS must be met and so on. It also runs all DEPENDS first.</para> </section> <section> - <title>Inter Task</title> + <title>Inter task</title> <para>The 'depends' flag for tasks is a more generic form of which allows an interdependency on specific tasks rather than specifying the data in DEPENDS or RDEPENDS.</para> <para><screen>do_patch[depends] = "quilt-native:do_populate_staging"</screen></para> <para>means the do_populate_staging task of the target quilt-native must have completed before the do_patch can execute.</para> @@ -278,35 +278,34 @@ <section> <title>Parsing</title> <section> - <title>Configuration Files</title> - <para>The first of the classifications of metadata in BitBake is configuration metadata. This metadata is global, and therefore affects <emphasis>all</emphasis> packages and tasks which are executed.</para> - <para>Bitbake will first search the current working directory for an optional "conf/bblayers.conf" configuration file. This file is expected to contain a BBLAYERS variable which is a space delimited list of 'layer' directories. For each directory in this list a "conf/layer.conf" file will be searched for and parsed with the LAYERDIR variable being set to the directory where the layer was found. The idea is these files will setup BBPATH and other variables correctly for a given build directory automatically for the user.</para> - <para>Bitbake will then expect to find 'conf/bitbake.conf' somewhere in the user specified <envar>BBPATH</envar>. That configuration file generally has include directives to pull in any other metadata (generally files specific to architecture, machine, <emphasis>local</emphasis> and so on.</para> + <title>Configuration files</title> + <para>The first kind of metadata in BitBake is configuration metadata. This metadata is global, and therefore affects <emphasis>all</emphasis> packages and tasks which are executed.</para> + <para>BitBake will first search the current working directory for an optional "conf/bblayers.conf" configuration file. This file is expected to contain a BBLAYERS variable which is a space delimited list of 'layer' directories. For each directory in this list, a "conf/layer.conf" file will be searched for and parsed with the LAYERDIR variable being set to the directory where the layer was found. The idea is these files will setup BBPATH and other variables correctly for a given build directory automatically for the user.</para> + <para>BitBake will then expect to find 'conf/bitbake.conf' somewhere in the user specified <envar>BBPATH</envar>. That configuration file generally has include directives to pull in any other metadata (generally files specific to architecture, machine, <emphasis>local</emphasis> and so on).</para> <para>Only variable definitions and include directives are allowed in .conf files.</para> </section> <section> <title>Classes</title> - <para>BitBake classes are our rudimentary inheritance mechanism. As briefly mentioned in the metadata introduction, they're parsed when an <literal>inherit</literal> directive is encountered, and they are located in classes/ relative to the dirs in <envar>BBPATH</envar>.</para> + <para>BitBake classes are our rudimentary inheritance mechanism. As briefly mentioned in the metadata introduction, they're parsed when an <literal>inherit</literal> directive is encountered, and they are located in classes/ relative to the directories in <envar>BBPATH</envar>.</para> </section> <section> - <title>.bb Files</title> + <title>.bb files</title> <para>A BitBake (.bb) file is a logical unit of tasks to be executed. Normally this is a package to be built. Inter-.bb dependencies are obeyed. The files themselves are located via the <varname>BBFILES</varname> variable, which is set to a space separated list of .bb files, and does handle wildcards.</para> </section> </section> </chapter> <chapter> - <title>File Download support</title> + <title>File download support</title> <section> <title>Overview</title> - <para>BitBake provides support to download files this procedure is called fetching. The SRC_URI is normally used to indicate BitBake which files to fetch. The next sections will describe th available fetchers and the options they have. Each Fetcher honors a set of Variables and -a per URI parameters separated by a <quote>;</quote> consisting of a key and a value. The semantic of the Variables and Parameters are defined by the Fetcher. BitBakes tries to have a consistent semantic between the different Fetchers. + <para>BitBake provides support to download files this procedure is called fetching. The SRC_URI is normally used to tell BitBake which files to fetch. The next sections will describe the available fetchers and their options. Each fetcher honors a set of variables and per URI parameters separated by a <quote>;</quote> consisting of a key and a value. The semantics of the variables and parameters are defined by the fetcher. BitBake tries to have consistent semantics between the different fetchers. </para> </section> <section> - <title>Local File Fetcher</title> - <para>The URN for the Local File Fetcher is <emphasis>file</emphasis>. The filename can be either absolute or relative. If the filename is relative <varname>FILESPATH</varname> and <varname>FILESDIR</varname> will be used to find the appropriate relative file depending on the <varname>OVERRIDES</varname>. Single files and complete directories can be specified. + <title>Local file fetcher</title> + <para>The URN for the local file fetcher is <emphasis>file</emphasis>. The filename can be either absolute or relative. If the filename is relative, <varname>FILESPATH</varname> and <varname>FILESDIR</varname> will be used to find the appropriate relative file, depending on the <varname>OVERRIDES</varname>. Single files and complete directories can be specified. <screen><varname>SRC_URI</varname>= "file://relativefile.patch" <varname>SRC_URI</varname>= "file://relativefile.patch;this=ignored" <varname>SRC_URI</varname>= "file:///Users/ich/very_important_software" @@ -315,10 +314,11 @@ </section> <section> - <title>CVS File Fetcher</title> - <para>The URN for the CVS Fetcher is <emphasis>cvs</emphasis>. This Fetcher honors the variables <varname>DL_DIR</varname>, <varname>SRCDATE</varname>, <varname>FETCHCOMMAND_cvs</varname>, <varname>UPDATECOMMAND_cvs</varname>. <varname>DL_DIR</varname> specifies where a temporary checkout is saved, <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build), <varname>FETCHCOMMAND</varname> and <varname>UPDATECOMMAND</varname> specify which executables should be used when doing the CVS checkout or update. + <title>CVS file fetcher</title> + <para>The URN for the CVS fetcher is <emphasis>cvs</emphasis>. This fetcher honors the variables <varname>DL_DIR</varname>, <varname>SRCDATE</varname>, <varname>FETCHCOMMAND_cvs</varname>, <varname>UPDATECOMMAND_cvs</varname>. <varname>DL_DIR</varname> specifies where a temporary checkout is saved. <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). <varname>FETCHCOMMAND</varname> and <varname>UPDATECOMMAND</varname> specify which executables to use for the CVS checkout or update. </para> - <para>The supported Parameters are <varname>module</varname>, <varname>tag</varname>, <varname>date</varname>, <varname>method</varname>, <varname>localdir</varname>, <varname>rsh</varname> and <varname>scmdata</varname>. The <varname>module</varname> specifies which module to check out, the <varname>tag</varname> describes which CVS TAG should be used for the checkout. By default the TAG is empty. A <varname>date</varname> can be specified to override the SRCDATE of the configuration to checkout a specific date. The special value of "now" will cause the checkout to be updated on every build.<varname>method</varname> is by default <emphasis>pserver</emphasis>, if <emphasis>ext</emphasis> is used the <varname>rsh</varname> parameter will be evaluated and <varname>CVS_RSH</varname> will be set. Finally <varname>localdir</varname> is used to checkout into a special directory relative to <varname>CVSDIR</varname>. If <varname>scmdata</varname> is set to <quote>keep</quote> + <para>The supported parameters are <varname>module</varname>, <varname>tag</varname>, <varname>date</varname>, <varname>method</varname>, <varname>localdir</varname>, <varname>rsh</varname> and <varname>scmdata</varname>. The <varname>module</varname> specifies which module to check out, the <varname>tag</varname> describes which CVS TAG should be used for the checkout. By default the TAG is empty. A <varname>date</varname> can be specified to override the SRCDATE of the configuration to checkout a specific date. The special value of "now" will cause the checkout to be updated on every build.<varname>method</varname> is by default <emphasis>pserver</emphasis>. If <emphasis>ext</emphasis> is used the <varname>rsh</varname> parameter will be evaluated and <varname>CVS_RSH</varname> will be set. Finally, <varname>localdir</varname> is used to checkout into a special directory relative to <varname>CVSDIR</varname>. + <screen><varname>SRC_URI</varname> = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" <varname>SRC_URI</varname> = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat" </screen> @@ -326,11 +326,10 @@ </section> <section> - <title>HTTP/FTP Fetcher</title> - <para>The URNs for the HTTP/FTP are <emphasis>http</emphasis>, <emphasis>https</emphasis> and <emphasis>ftp</emphasis>. This Fetcher honors the variables <varname>DL_DIR</varname>, <varname>FETCHCOMMAND_wget</varname>, <varname>PREMIRRORS</varname>, <varname>MIRRORS</varname>. The <varname>DL_DIR</varname> defines where to store the fetched file, <varname>FETCHCOMMAND</varname> contains the command used for fetching. <quote>${URI}</quote> and <quote>${FILES}</quote> will be replaced by the uri and basename of the to be fetched file. <varname>PREMIRRORS</varname> -will be tried first when fetching a file if that fails the actual file will be tried and finally all <varname>MIRRORS</varname> will be tried. + <title>HTTP/FTP fetcher</title> + <para>The URNs for the HTTP/FTP fetcher are <emphasis>http</emphasis>, <emphasis>https</emphasis> and <emphasis>ftp</emphasis>. This fetcher honors the variables <varname>DL_DIR</varname>, <varname>FETCHCOMMAND_wget</varname>, <varname>PREMIRRORS</varname>, <varname>MIRRORS</varname>. The <varname>DL_DIR</varname> defines where to store the fetched file. <varname>FETCHCOMMAND</varname> contains the command used for fetching. <quote>${URI}</quote> and <quote>${FILES}</quote> will be replaced by the URI and basename of the file to be fetched. <varname>PREMIRRORS</varname> will be tried first when fetching a file. If that fails, the actual file will be tried and finally all <varname>MIRRORS</varname> will be tried. </para> - <para>The only supported Parameter is <varname>md5sum</varname>. After a fetch the <varname>md5sum</varname> of the file will be calculated and the two sums will be compared. + <para>The only supported parameter is <varname>md5sum</varname>. After a fetch the <varname>md5sum</varname> of the file will be calculated and the two sums will be compared. </para> <para><screen><varname>SRC_URI</varname> = "http://oe.handhelds.org/not_there.aac;md5sum=12343" <varname>SRC_URI</varname> = "ftp://oe.handhelds.org/not_there_as_well.aac;md5sum=1234" @@ -339,19 +338,19 @@ </section> <section> - <title>SVK Fetcher</title> + <title>SVK fetcher</title> <para> <emphasis>Currently NOT supported</emphasis> </para> </section> <section> - <title>SVN Fetcher</title> - <para>The URN for the SVN Fetcher is <emphasis>svn</emphasis>. + <title>SVN fetcher</title> + <para>The URN for the SVN fetcher is <emphasis>svn</emphasis>. </para> - <para>This Fetcher honors the variables <varname>FETCHCOMMAND_svn</varname>, <varname>DL_DIR</varname>, <varname>SRCDATE</varname>. <varname>FETCHCOMMAND</varname> contains the subversion command, <varname>DL_DIR</varname> is the directory where tarballs will be saved, <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). + <para>This fetcher honors the variables <varname>FETCHCOMMAND_svn</varname>, <varname>DL_DIR</varname>, <varname>SRCDATE</varname>. <varname>FETCHCOMMAND</varname> contains the subversion command. <varname>DL_DIR</varname> is the directory where tarballs will be saved. <varname>SRCDATE</varname> specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). </para> - <para>The supported Parameters are <varname>proto</varname>, <varname>rev</varname> and <varname>scmdata</varname>. <varname>proto</varname> is the subversion protocol, <varname>rev</varname> is the subversion revision. If <varname>scmdata</varname> is set to <quote>keep</quote>, the <quote>.svn</quote> directories will be available during compile-time. + <para>The supported parameters are <varname>proto</varname>, <varname>rev</varname> and <varname>scmdata</varname>. <varname>proto</varname> is the Subversion protocol, <varname>rev</varname> is the Subversion revision. If <varname>scmdata</varname> is set to <quote>keep</quote>, the <quote>.svn</quote> directories will be available during compile-time. </para> <para><screen><varname>SRC_URI</varname> = "svn://svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667" <varname>SRC_URI</varname> = "svn://svn.oe.handhelds.org/svn/;module=opie;proto=svn+ssh;date=20060126" @@ -359,12 +358,12 @@ </section> <section> - <title>GIT Fetcher</title> + <title>GIT fetcher</title> <para>The URN for the GIT Fetcher is <emphasis>git</emphasis>. </para> <para>The Variables <varname>DL_DIR</varname>, <varname>GITDIR</varname> are used. <varname>DL_DIR</varname> will be used to store the checkedout version. <varname>GITDIR</varname> will be used as the base directory where the git tree is cloned to. </para> - <para>The Parameters are <emphasis>tag</emphasis>, <emphasis>protocol</emphasis> and <emphasis>scmdata</emphasis>. <emphasis>tag</emphasis> is a git tag, the default is <quote>master</quote>. <emphasis>protocol</emphasis> is the git protocol to use and defaults to <quote>rsync</quote>. If <emphasis>scmdata</emphasis> is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available during compile-time. + <para>The parameters are <emphasis>tag</emphasis>, <emphasis>protocol</emphasis> and <emphasis>scmdata</emphasis>. <emphasis>tag</emphasis> is a Git tag, the default is <quote>master</quote>. <emphasis>protocol</emphasis> is the Git protocol to use and defaults to <quote>rsync</quote>. If <emphasis>scmdata</emphasis> is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available during compile-time. </para> <para><screen><varname>SRC_URI</varname> = "git://git.oe.handhelds.org/git/vip.git;tag=version-1" <varname>SRC_URI</varname> = "git://git.oe.handhelds.org/git/vip.git;protocol=http" @@ -375,13 +374,13 @@ <chapter> - <title>The bitbake command</title> + <title>The BitBake command</title> <section> <title>Introduction</title> <para>bitbake is the primary command in the system. It facilitates executing tasks in a single .bb file, or executing a given task on a set of multiple .bb files, accounting for interdependencies amongst them.</para> </section> <section> - <title>Usage and Syntax</title> + <title>Usage and syntax</title> <para> <screen><prompt>$ </prompt>bitbake --help usage: bitbake [options] [package ...] @@ -438,7 +437,7 @@ <para> <example> <title>Executing a task against a single .bb</title> - <para>Executing tasks for a single file is relatively simple. You specify the file in question, and bitbake parses it and executes the specified task (or <quote>build</quote> by default). It obeys intertask dependencies when doing so.</para> + <para>Executing tasks for a single file is relatively simple. You specify the file in question, and BitBake parses it and executes the specified task (or <quote>build</quote> by default). It obeys intertask dependencies when doing so.</para> <para><quote>clean</quote> task:</para> <para><screen><prompt>$ </prompt>bitbake -b blah_1.0.bb -c clean</screen></para> <para><quote>build</quote> task:</para> @@ -448,8 +447,8 @@ <para> <example> <title>Executing tasks against a set of .bb files</title> - <para>There are a number of additional complexities introduced when one wants to manage multiple .bb files. Clearly there needs to be a way to tell bitbake what files are available, and of those, which we want to execute at this time. There also needs to be a way for each .bb to express its dependencies, both for build time and runtime. There must be a way for the user to express their preferences when multiple .bb's provide the same functionality, or when there are multiple versions of a .bb.</para> - <para>The next section, Metadata, outlines how one goes about specifying such things.</para> + <para>There are a number of additional complexities introduced when one wants to manage multiple .bb files. Clearly there needs to be a way to tell BitBake what files are available, and of those, which we want to execute at this time. There also needs to be a way for each .bb to express its dependencies, both for build time and runtime. There must be a way for the user to express their preferences when multiple .bb's provide the same functionality, or when there are multiple versions of a .bb.</para> + <para>The next section, Metadata, outlines how to specify such things.</para> <para>Note that the bitbake command, when not using --buildfile, accepts a <varname>PROVIDER</varname>, not a filename or anything else. By default, a .bb generally PROVIDES its packagename, packagename-version, and packagename-version-revision.</para> <screen><prompt>$ </prompt>bitbake blah</screen> <screen><prompt>$ </prompt>bitbake blah-1.0</screen> @@ -461,8 +460,8 @@ <example> <title>Generating dependency graphs</title> <para>BitBake is able to generate dependency graphs using the dot syntax. These graphs can be converted -to images using the <application>dot</application> application from <ulink url="http://www.graphviz.org">graphviz</ulink>. -Two files will be written into the current working directory, <emphasis>depends.dot</emphasis> containing dependency information at the package level and <emphasis>task-depends.dot</emphasis> containing a breakdown of the dependencies at the task level. To stop depending on common depends one can use the <prompt>-I depend</prompt> to omit these from the graph. This can lead to more readable graphs. E.g. this way <varname>DEPENDS</varname> from inherited classes, e.g. base.bbclass, can be removed from the graph.</para> +to images using the <application>dot</application> application from <ulink url="http://www.graphviz.org">Graphviz</ulink>. +Two files will be written into the current working directory, <emphasis>depends.dot</emphasis> containing dependency information at the package level and <emphasis>task-depends.dot</emphasis> containing a breakdown of the dependencies at the task level. To stop depending on common depends, one can use the <prompt>-I depend</prompt> to omit these from the graph. This can lead to more readable graphs. This way, <varname>DEPENDS</varname> from inherited classes such as base.bbclass can be removed from the graph.</para> <screen><prompt>$ </prompt>bitbake -g blah</screen> <screen><prompt>$ </prompt>bitbake -g -I virtual/whatever -I bloom blah</screen> </example> @@ -470,20 +469,20 @@ </section> <section> <title>Special variables</title> - <para>Certain variables affect bitbake operation:</para> + <para>Certain variables affect BitBake operation:</para> <section> <title><varname>BB_NUMBER_THREADS</varname></title> - <para> The number of threads bitbake should run at once (default: 1).</para> + <para> The number of threads BitBake should run at once (default: 1).</para> </section> </section> <section> <title>Metadata</title> - <para>As you may have seen in the usage information, or in the information about .bb files, the BBFILES variable is how the bitbake tool locates its files. This variable is a space separated list of files that are available, and supports wildcards. + <para>As you may have seen in the usage information, or in the information about .bb files, the <varname>BBFILES</varname> variable is how the BitBake tool locates its files. This variable is a space separated list of files that are available, and supports wildcards. <example> <title>Setting BBFILES</title> <programlisting><varname>BBFILES</varname> = "/path/to/bbfiles/*.bb"</programlisting> </example></para> - <para>With regard to dependencies, it expects the .bb to define a <varname>DEPENDS</varname> variable, which contains a space separated list of <quote>package names</quote>, which themselves are the <varname>PN</varname> variable. The <varname>PN</varname> variable is, in general, by default, set to a component of the .bb filename.</para> + <para>With regard to dependencies, it expects the .bb to define a <varname>DEPENDS</varname> variable, which contains a space separated list of <quote>package names</quote>, which themselves are the <varname>PN</varname> variable. The <varname>PN</varname> variable is, in general, set to a component of the .bb filename by default.</para> <example> <title>Depending on another .bb</title> <para>a.bb: @@ -496,7 +495,7 @@ </example> <example> <title>Using PROVIDES</title> - <para>This example shows the usage of the PROVIDES variable, which allows a given .bb to specify what functionality it provides.</para> + <para>This example shows the usage of the <varname>PROVIDES</varname> variable, which allows a given .bb to specify what functionality it provides.</para> <para>package1.bb: <screen>PROVIDES += "virtual/package"</screen> </para> @@ -506,16 +505,16 @@ <para>package3.bb: <screen>PROVIDES += "virtual/package"</screen> </para> - <para>As you can see, here there are two different .bb's that provide the same functionality (virtual/package). Clearly, there needs to be a way for the person running bitbake to control which of those providers gets used. There is, indeed, such a way.</para> + <para>As you can see, we have two different .bb's that provide the same functionality (virtual/package). Clearly, there needs to be a way for the person running BitBake to control which of those providers gets used. There is, indeed, such a way.</para> <para>The following would go into a .conf file, to select package1: <screen>PREFERRED_PROVIDER_virtual/package = "package1"</screen> </para> </example> <example> <title>Specifying version preference</title> - <para>When there are multiple <quote>versions</quote> of a given package, bitbake defaults to selecting the most recent version, unless otherwise specified. If the .bb in question has a <varname>DEFAULT_PREFERENCE</varname> set lower than the other .bb's (default is 0), then it will not be selected. This allows the person or persons maintaining the repository of .bb files to specify their preferences for the default selected version. In addition, the user can specify their preferences with regard to version.</para> + <para>When there are multiple <quote>versions</quote> of a given package, BitBake defaults to selecting the most recent version, unless otherwise specified. If the .bb in question has a <varname>DEFAULT_PREFERENCE</varname> set lower than the other .bb's (default is 0), then it will not be selected. This allows the person or persons maintaining the repository of .bb files to specify their preference for the default selected version. In addition, the user can specify their preferred version.</para> <para>If the first .bb is named <filename>a_1.1.bb</filename>, then the <varname>PN</varname> variable will be set to <quote>a</quote>, and the <varname>PV</varname> variable will be set to 1.1.</para> - <para>If we then have an <filename>a_1.2.bb</filename>, bitbake will choose 1.2 by default. However, if we define the following variable in a .conf that bitbake parses, we can change that. + <para>If we then have an <filename>a_1.2.bb</filename>, BitBake will choose 1.2 by default. However, if we define the following variable in a .conf that BitBake parses, we can change that. <screen>PREFERRED_VERSION_a = "1.1"</screen> </para> </example> ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 1/1] Fix some punctuation, wording, and caps in manual 2011-06-07 23:07 ` Brandon Stafford @ 2011-06-22 13:38 ` Paul Eggleton 2011-06-22 15:31 ` Richard Purdie 1 sibling, 0 replies; 5+ messages in thread From: Paul Eggleton @ 2011-06-22 13:38 UTC (permalink / raw) To: bitbake-devel; +Cc: Brandon Stafford On Wednesday 08 June 2011 00:07:03 Brandon Stafford wrote: > I'm sending the patch as an attachment; we'll see if that produces more > success. Looks good to me, FWIW. Cheers, Paul -- Paul Eggleton Intel Open Source Technology Centre ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 1/1] Fix some punctuation, wording, and caps in manual 2011-06-07 23:07 ` Brandon Stafford 2011-06-22 13:38 ` Paul Eggleton @ 2011-06-22 15:31 ` Richard Purdie 1 sibling, 0 replies; 5+ messages in thread From: Richard Purdie @ 2011-06-22 15:31 UTC (permalink / raw) To: Brandon Stafford; +Cc: bitbake-devel On Tue, 2011-06-07 at 19:07 -0400, Brandon Stafford wrote: > On Tue, Jun 7, 2011 at 5:55 PM, Richard Purdie > <richard.purdie@linuxfoundation.org> wrote: > > > > Hi Brandon, > > > > On Fri, 2011-06-03 at 12:14 -0400, Brandon Stafford wrote: > > > This patch contains what I hope are non-controversial improvements to > > > the manual. Most of the changes are single characters, but the > > > line-by-line diff makes the patch look large. > > > > > > This is my first patch to Bitbake, so please don't kill me > > > immediately. (I originally sent this message, minus this sentence, > > > around 2011-03-10, but the bitbake-dev list appeared to be silently > > > dropping messages from 2011-03-07 until 2011-03-24. I resent it again > > > on 2011-03-27. I'm now sending it to the post-migration bitbake-devel > > > list on 2011-06-03.) > > > > > > Signed-off-by: Brandon Stafford <brandon@pingswept.org> > > > > I tried to get this to apply but the patch appears corrupt and I can't > > convince the patch tools to accept it. It looks like you sent html email > > and that your mailer line wrapped the text in some way too. > > > > Revised patch and retested against current HEAD (commit > 077657e50ad032c0fa876bf54e9802af2686e0fb). > > Now works for me with: patch -p1 < > Revised-fixes-to-punctuation-wording-and-caps-in-manual.patch > > I'm sending the patch as an attachment; we'll see if that produces more success. It did and I've applied it to master, thanks. Richard ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2011-06-22 15:35 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <AANLkTikY20mQoKfNaY6xsokcVabDnnaQKrvAmumBvv77@mail.gmail.com>
2011-06-03 16:14 ` [PATCH 1/1] Fix some punctuation, wording, and caps in manual Brandon Stafford
2011-06-07 21:55 ` Richard Purdie
2011-06-07 23:07 ` Brandon Stafford
2011-06-22 13:38 ` Paul Eggleton
2011-06-22 15:31 ` Richard Purdie
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.