summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/usingpoky.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-28 15:46:58 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-30 10:18:38 +0100
commit4a3a747c77dfb180720b5bc41a41738d96b2db54 (patch)
treef87995eaaf0a539977f47ae9d99dae1a9b4d52ce /documentation/ref-manual/usingpoky.xml
parenta4f8da56956045599fccd918c88a87360fb5211d (diff)
downloadpoky-4a3a747c77dfb180720b5bc41a41738d96b2db54.tar.gz
ref-manual: Edits to the "Using" chapter.
Along with some minor things I did the following: * Added a brief explanation and reference to the reporting error tool. It seemed like a good chapter to include it. I put it in the debugging section. * I added a pointer to the BitBake manual right at the top of a section that had many usages of the bitbake command. (From yocto-docs rev: 9317433bc715e9fdac2fc629ed659ac926d67531) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/usingpoky.xml')
-rw-r--r--documentation/ref-manual/usingpoky.xml38
1 files changed, 30 insertions, 8 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index 5799b2b973..a8a6f3b92a 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -48,8 +48,6 @@
48 A common practice is to use a different Build Directory for different targets. 48 A common practice is to use a different Build Directory for different targets.
49 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename> 49 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename>
50 target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target. 50 target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target.
51 See the "<link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>"
52 section for more information on this script.
53 </para> 51 </para>
54 52
55 <para> 53 <para>
@@ -111,17 +109,31 @@
111 <title>Debugging Build Failures</title> 109 <title>Debugging Build Failures</title>
112 110
113 <para> 111 <para>
114 The exact method for debugging build failures depends on the nature of the 112 The exact method for debugging build failures depends on the nature of
115 problem and on the system's area from which the bug originates. 113 the problem and on the system's area from which the bug originates.
116 Standard debugging practices such as comparison against the last 114 Standard debugging practices such as comparison against the last
117 known working version with examination of the changes and the re-application of steps 115 known working version with examination of the changes and the
118 to identify the one causing the problem are 116 re-application of steps to identify the one causing the problem are
119 valid for the Yocto Project just as they are for any other system. 117 valid for the Yocto Project just as they are for any other system.
120 Even though it is impossible to detail every possible potential failure, 118 Even though it is impossible to detail every possible potential failure,
121 this section provides some general tips to aid in debugging. 119 this section provides some general tips to aid in debugging.
122 </para> 120 </para>
123 121
124 <para> 122 <para>
123 A useful feature for debugging is the error reporting tool.
124 Configuring the Yocto Project to use this tool causes the
125 OpenEmbedded build system to produce error reporting commands as
126 part of the console output.
127 You can enter the commands after the build completes
128 to log error information
129 into a common database, that can help you figure out what might be
130 going wrong.
131 For information on how to enable and use this feature, see the
132 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>Using the Error Reporting Tool</ulink>"
133 section in the Yocto Project Development Manual.
134 </para>
135
136 <para>
125 For discussions on debugging, see the 137 For discussions on debugging, see the
126 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" 138 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
127 and 139 and
@@ -129,6 +141,14 @@
129 sections in the Yocto Project Development Manual. 141 sections in the Yocto Project Development Manual.
130 </para> 142 </para>
131 143
144 <note>
145 The remainder of this section presents many examples of the
146 <filename>bitbake</filename> command.
147 You can learn about BitBake by reading the
148 <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink>.
149 </note>
150
151
132 <section id='usingpoky-debugging-taskfailures'> 152 <section id='usingpoky-debugging-taskfailures'>
133 <title>Task Failures</title> 153 <title>Task Failures</title>
134 154
@@ -137,7 +157,9 @@
137 For example, the <filename>compile</filename> task for the QEMU minimal image for the x86 157 For example, the <filename>compile</filename> task for the QEMU minimal image for the x86
138 machine (<filename>qemux86</filename>) might be 158 machine (<filename>qemux86</filename>) might be
139 <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>. 159 <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>.
140 To see what BitBake runs to generate that log, look at the corresponding 160 To see what
161 <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>
162 runs to generate that log, look at the corresponding
141 <filename>run.do_taskname.pid</filename> file located in the same directory. 163 <filename>run.do_taskname.pid</filename> file located in the same directory.
142 </para> 164 </para>
143 165
@@ -285,7 +307,7 @@
285 </literallayout> 307 </literallayout>
286 This command form does not check for dependencies. 308 This command form does not check for dependencies.
287 Consequently, you should use it 309 Consequently, you should use it
288 only when you know dependencies already exist. 310 only when you know existing dependencies have been met.
289 <note> 311 <note>
290 You can also specify fragments of the filename. 312 You can also specify fragments of the filename.
291 In this case, BitBake checks for a unique match. 313 In this case, BitBake checks for a unique match.