diff options
Diffstat (limited to 'bitbake/doc')
5 files changed, 36 insertions, 28 deletions
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 @@ | |||
21 | The execution process is launched using the following command | 21 | The execution process is launched using the following command |
22 | form: | 22 | form: |
23 | <literallayout class='monospaced'> | 23 | <literallayout class='monospaced'> |
24 | $ bitbake <target> | 24 | $ bitbake <replaceable>target</replaceable> |
25 | </literallayout> | 25 | </literallayout> |
26 | For information on the BitBake command and its options, | 26 | For information on the BitBake command and its options, |
27 | see | 27 | see |
@@ -37,14 +37,16 @@ | |||
37 | </para> | 37 | </para> |
38 | 38 | ||
39 | <para> | 39 | <para> |
40 | A common way to determine this value for your build host is to run: | 40 | A common method to determine this value for your build host is to run |
41 | the following: | ||
41 | <literallayout class='monospaced'> | 42 | <literallayout class='monospaced'> |
42 | $ grep processor /proc/cpuinfo | 43 | $ grep processor /proc/cpuinfo |
43 | </literallayout> | 44 | </literallayout> |
44 | and count the number of processors displayed. Note that the number of | 45 | This command returns the number of processors, which takes into |
45 | processors will take into account hyper-threading, so that a quad-core | 46 | account hyper-threading. |
46 | build host with hyper-threading will most likely show eight processors, | 47 | Thus, a quad-core build host with hyper-threading most likely |
47 | which is the value you would then assign to that variable. | 48 | shows eight processors, which is the value you would then assign to |
49 | <filename>BB_NUMBER_THREADS</filename>. | ||
48 | </para> | 50 | </para> |
49 | 51 | ||
50 | <para> | 52 | <para> |
@@ -782,13 +784,13 @@ | |||
782 | make some dependency and hash information available to the build. | 784 | make some dependency and hash information available to the build. |
783 | This information includes: | 785 | This information includes: |
784 | <itemizedlist> | 786 | <itemizedlist> |
785 | <listitem><para><filename>BB_BASEHASH_task-<taskname></filename>: | 787 | <listitem><para><filename>BB_BASEHASH_task-</filename><replaceable>taskname</replaceable>: |
786 | The base hashes for each task in the recipe. | 788 | The base hashes for each task in the recipe. |
787 | </para></listitem> | 789 | </para></listitem> |
788 | <listitem><para><filename>BB_BASEHASH_<filename:taskname></filename>: | 790 | <listitem><para><filename>BB_BASEHASH_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>: |
789 | The base hashes for each dependent task. | 791 | The base hashes for each dependent task. |
790 | </para></listitem> | 792 | </para></listitem> |
791 | <listitem><para><filename>BBHASHDEPS_<filename:taskname></filename>: | 793 | <listitem><para><filename>BBHASHDEPS_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>: |
792 | The task dependencies for each task. | 794 | The task dependencies for each task. |
793 | </para></listitem> | 795 | </para></listitem> |
794 | <listitem><para><filename>BB_TASKHASH</filename>: | 796 | <listitem><para><filename>BB_TASKHASH</filename>: |
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 @@ | |||
157 | <filename>SRC_URI</filename> variable with the appropriate | 157 | <filename>SRC_URI</filename> variable with the appropriate |
158 | varflags as follows: | 158 | varflags as follows: |
159 | <literallayout class='monospaced'> | 159 | <literallayout class='monospaced'> |
160 | SRC_URI[md5sum] = "value" | 160 | SRC_URI[md5sum] = "<replaceable>value</replaceable>" |
161 | SRC_URI[sha256sum] = "value" | 161 | SRC_URI[sha256sum] = "<replaceable>value</replaceable>" |
162 | </literallayout> | 162 | </literallayout> |
163 | You can also specify the checksums as parameters on the | 163 | You can also specify the checksums as parameters on the |
164 | <filename>SRC_URI</filename> as shown below: | 164 | <filename>SRC_URI</filename> as shown below: |
@@ -646,13 +646,19 @@ | |||
646 | </para></listitem> | 646 | </para></listitem> |
647 | <listitem><para><emphasis><filename>module</filename></emphasis>: | 647 | <listitem><para><emphasis><filename>module</filename></emphasis>: |
648 | The module, which must include the | 648 | The module, which must include the |
649 | prepending "/" character, in the selected VOB | 649 | prepending "/" character, in the selected VOB. |
650 | The <filename>module</filename> and <filename>vob</filename> | 650 | <note> |
651 | options are combined to create the following load rule in | 651 | The <filename>module</filename> and <filename>vob</filename> |
652 | the view config spec: | 652 | options are combined to create the <filename>load</filename> rule in |
653 | <literallayout class='monospaced'> | 653 | the view config spec. |
654 | load <vob><module> | 654 | As an example, consider the <filename>vob</filename> and |
655 | </literallayout> | 655 | <filename>module</filename> values from the |
656 | <filename>SRC_URI</filename> statement at the start of this section. | ||
657 | Combining those values results in the following: | ||
658 | <literallayout class='monospaced'> | ||
659 | load /example_vob/example_module | ||
660 | </literallayout> | ||
661 | </note> | ||
656 | </para></listitem> | 662 | </para></listitem> |
657 | <listitem><para><emphasis><filename>proto</filename></emphasis>: | 663 | <listitem><para><emphasis><filename>proto</filename></emphasis>: |
658 | The protocol, which can be either <filename>http</filename> or | 664 | The protocol, which can be either <filename>http</filename> 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 @@ | |||
221 | <para>From your shell, enter the following commands to set and | 221 | <para>From your shell, enter the following commands to set and |
222 | export the <filename>BBPATH</filename> variable: | 222 | export the <filename>BBPATH</filename> variable: |
223 | <literallayout class='monospaced'> | 223 | <literallayout class='monospaced'> |
224 | $ BBPATH="<projectdirectory>" | 224 | $ BBPATH="<replaceable>projectdirectory</replaceable>" |
225 | $ export BBPATH | 225 | $ export BBPATH |
226 | </literallayout> | 226 | </literallayout> |
227 | Use your actual project directory in the command. | 227 | 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 @@ | |||
952 | <listitem><para> | 952 | <listitem><para> |
953 | The class needs to define the function as follows: | 953 | The class needs to define the function as follows: |
954 | <literallayout class='monospaced'> | 954 | <literallayout class='monospaced'> |
955 | <classname>_<functionname> | 955 | <replaceable>classname</replaceable><filename>_</filename><replaceable>functionname</replaceable> |
956 | </literallayout> | 956 | </literallayout> |
957 | For example, if you have a class file | 957 | For example, if you have a class file |
958 | <filename>bar.bbclass</filename> and a function named | 958 | <filename>bar.bbclass</filename> and a function named |
@@ -966,7 +966,7 @@ | |||
966 | The class needs to contain the <filename>EXPORT_FUNCTIONS</filename> | 966 | The class needs to contain the <filename>EXPORT_FUNCTIONS</filename> |
967 | statement as follows: | 967 | statement as follows: |
968 | <literallayout class='monospaced'> | 968 | <literallayout class='monospaced'> |
969 | EXPORT_FUNCTIONS <functionname> | 969 | EXPORT_FUNCTIONS <replaceable>functionname</replaceable> |
970 | </literallayout> | 970 | </literallayout> |
971 | For example, continuing with the same example, the | 971 | For example, continuing with the same example, the |
972 | statement in the <filename>bar.bbclass</filename> would be | 972 | statement in the <filename>bar.bbclass</filename> would be |
@@ -1164,7 +1164,7 @@ | |||
1164 | BitBake reads and writes varflags to the datastore using the following | 1164 | BitBake reads and writes varflags to the datastore using the following |
1165 | command forms: | 1165 | command forms: |
1166 | <literallayout class='monospaced'> | 1166 | <literallayout class='monospaced'> |
1167 | <variable> = d.getVarFlags("<variable>") | 1167 | <replaceable>variable</replaceable> = d.getVarFlags("<replaceable>variable</replaceable>") |
1168 | self.d.setVarFlags("FOO", {"func": True}) | 1168 | self.d.setVarFlags("FOO", {"func": True}) |
1169 | </literallayout> | 1169 | </literallayout> |
1170 | </para> | 1170 | </para> |
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 @@ | |||
872 | that run on the target <filename>MACHINE</filename>; | 872 | that run on the target <filename>MACHINE</filename>; |
873 | "nativesdk", which targets the SDK machine instead of | 873 | "nativesdk", which targets the SDK machine instead of |
874 | <filename>MACHINE</filename>; and "mulitlibs" in the form | 874 | <filename>MACHINE</filename>; and "mulitlibs" in the form |
875 | "<filename>multilib:<multilib_name></filename>". | 875 | "<filename>multilib:</filename><replaceable>multilib_name</replaceable>". |
876 | </para> | 876 | </para> |
877 | 877 | ||
878 | <para> | 878 | <para> |
@@ -884,7 +884,7 @@ | |||
884 | metadata: | 884 | metadata: |
885 | <literallayout class='monospaced'> | 885 | <literallayout class='monospaced'> |
886 | BBCLASSEXTEND =+ "native nativesdk" | 886 | BBCLASSEXTEND =+ "native nativesdk" |
887 | BBCLASSEXTEND =+ "multilib:<multilib_name>" | 887 | BBCLASSEXTEND =+ "multilib:<replaceable>multilib_name</replaceable>" |
888 | </literallayout> | 888 | </literallayout> |
889 | </para> | 889 | </para> |
890 | </glossdef> | 890 | </glossdef> |
@@ -1091,9 +1091,9 @@ | |||
1091 | Set the variable as you would any environment variable | 1091 | Set the variable as you would any environment variable |
1092 | and then run BitBake: | 1092 | and then run BitBake: |
1093 | <literallayout class='monospaced'> | 1093 | <literallayout class='monospaced'> |
1094 | $ BBPATH="<build_directory>" | 1094 | $ BBPATH="<replaceable>build_directory</replaceable>" |
1095 | $ export BBPATH | 1095 | $ export BBPATH |
1096 | $ bitbake <target> | 1096 | $ bitbake <replaceable>target</replaceable> |
1097 | </literallayout> | 1097 | </literallayout> |
1098 | </para> | 1098 | </para> |
1099 | </glossdef> | 1099 | </glossdef> |
@@ -1888,7 +1888,7 @@ | |||
1888 | Here is the general syntax to specify versions with | 1888 | Here is the general syntax to specify versions with |
1889 | the <filename>RDEPENDS</filename> variable: | 1889 | the <filename>RDEPENDS</filename> variable: |
1890 | <literallayout class='monospaced'> | 1890 | <literallayout class='monospaced'> |
1891 | RDEPENDS_${PN} = "<package> (<operator> <version>)" | 1891 | RDEPENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" |
1892 | </literallayout> | 1892 | </literallayout> |
1893 | For <filename>operator</filename>, you can specify the | 1893 | For <filename>operator</filename>, you can specify the |
1894 | following: | 1894 | following: |
@@ -1954,7 +1954,7 @@ | |||
1954 | Here is the general syntax to specify versions with | 1954 | Here is the general syntax to specify versions with |
1955 | the <filename>RRECOMMENDS</filename> variable: | 1955 | the <filename>RRECOMMENDS</filename> variable: |
1956 | <literallayout class='monospaced'> | 1956 | <literallayout class='monospaced'> |
1957 | RRECOMMENDS_${PN} = "<package> (<operator> <version>)" | 1957 | RRECOMMENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" |
1958 | </literallayout> | 1958 | </literallayout> |
1959 | For <filename>operator</filename>, you can specify the | 1959 | For <filename>operator</filename>, you can specify the |
1960 | following: | 1960 | following: |