summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-17 15:07:11 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-27 21:03:18 +0000
commit5b60a81c9510b5c2198ade0ada6878ec9dbeaa65 (patch)
tree9d0f2596c49cec63a040a23fc1f4807c6c7e6861
parente925730cd8b68e11ac1b50f6cad0dfc05d83769a (diff)
downloadpoky-5b60a81c9510b5c2198ade0ada6878ec9dbeaa65.tar.gz
bitbake: user-manual-intro: Add obtaining bitbake and summary sections
Add new obtaining bitbake and summary sections from Bill Traynor (Bitbake rev: 083e4e44f52ffdfca68ce6c56eae85ce3b719e1b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--bitbake/doc/user-manual/user-manual-intro.xml83
1 files changed, 83 insertions, 0 deletions
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml
index 88c415cc58..2ab049eacd 100644
--- a/bitbake/doc/user-manual/user-manual-intro.xml
+++ b/bitbake/doc/user-manual/user-manual-intro.xml
@@ -228,4 +228,87 @@
228 </para> 228 </para>
229 </section> 229 </section>
230 </section> 230 </section>
231
232 <section id='obtaining-bitbake'>
233 <title>Obtaining BitBake</title>
234
235 <para>
236 There are several ways to obtain BitBake.
237 These include installing using your Linux distribution's
238 package management system (not recommended), downloading
239 a snapshot from the BitBake source
240 code repository, or using Git to clone the BitBake source
241 code repository.
242 The recommended method for daily BitBake use is to download
243 a stable release from the BitBake source code repository.
244 Using your distribution's version as provided in the package
245 management system is generally not
246 recommended as in most cases, such as with the Ubuntu and
247 Fedora distributions, the version provided is several releases
248 behind the repository snapshot version and is missing
249 important bug fixes and enhancements. Similarly, daily use
250 of the latest clone of the Git repository is not recommended
251 as it can be unstable.
252 However, the Git repository clone will provide the User
253 with the absolute latest version of BitBake.
254 </para>
255 </section>
256
257 <section id='downloading-a-snapshot-from-the-bitbake-source-tree'>
258 <title>Downloading a Snapshot from the BitBake Source Tree</title>
259
260 <para>
261 The recommended method for obtaining and using BitBake on
262 a daily basis is to download the most
263 recent stable snapshot from the Git source code repository
264 as follows:
265 <literallayout class='monospaced'>
266 $ wget http://git.openembedded.org/bitbake/snapshot/bitbake-1.17.0.tar.gz
267 $ tar zxpvf bitbake-1.17.0.tar.gz
268 </literallayout>
269 After extraction of the tarball using the tar utility,
270 you will have a directory entitled
271 <filename>bitbake-1.17.0</filename>.
272 </para>
273 </section>
274
275 <section id='cloning-the-bitbake-git-repository'>
276 <title>Cloning the BitBake Git Repository</title>
277
278 <para>
279 To obtain the latest BitBake source code from the
280 BitBake Git repository:
281 <literallayout class='monospaced'>
282 $ git clone git://git.openembedded.org/bitbake
283 </literallayout>
284 This will clone the BitBake Git repository into a
285 directory called <filename>bitbake</filename>.
286 Alternatively, you can
287 designate a directory after the git clone command
288 if you'd prefer to call the new directory something
289 other than <filename>bitbake</filename>.
290 For example:
291 <literallayout class='monospaced'>
292 $ git clone git://git.openembedded.org/bitbake bbdev
293 </literallayout>
294 This would clone the Git repository into a local directory
295 called <filename>bbdev</filename>.
296 Please note that although this method of obtaining the
297 source code will provide the absolute latest version,
298 it is under active development and may not be as stable
299 as a released snapshot.
300 </para>
301 </section>
302
303 <section id='summary'>
304 <title>Summary</title>
305
306 <para>
307 At this point you should have a general idea of the concepts
308 that BitBake was built on and how the
309 source code is organized.
310 You should have a working version of BitBake installed
311 and understand how to setup your environment.
312 </para>
313 </section>
231</chapter> 314</chapter>