From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from astoria.ccjclearline.com (astoria.ccjclearline.com [64.235.106.9]) by mail.openembedded.org (Postfix) with ESMTP id 8425E7035F for ; Mon, 7 Jul 2014 13:47:29 +0000 (UTC) Received: from [69.196.158.250] (port=40676 helo=crashcourse.ca) by astoria.ccjclearline.com with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.80) (envelope-from ) id 1X49GU-0005HM-32 for bitbake-devel@lists.openembedded.org; Mon, 07 Jul 2014 09:47:30 -0400 Date: Mon, 7 Jul 2014 09:47:22 -0400 (EDT) From: "Robert P. J. Day" X-X-Sender: rpjday@localhost To: BitBake developer list Message-ID: User-Agent: Alpine 2.11 (LFD 23 2013-08-11) MIME-Version: 1.0 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - astoria.ccjclearline.com X-AntiAbuse: Original Domain - lists.openembedded.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - crashcourse.ca X-Source: X-Source-Args: X-Source-Dir: Subject: [PATCH] Documentation: A few more tweaks to Chapter 1, BitBake User Manual. X-BeenThere: bitbake-devel@lists.openembedded.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: Patches and discussion that advance bitbake development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 07 Jul 2014 13:47:37 -0000 Content-Type: TEXT/PLAIN; charset=US-ASCII Signed-off-by: Robert P. J. Day --- diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml index af2400f..bf39857 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml @@ -212,11 +212,12 @@ Where the source code resides and how to fetch it Whether the source code requires - any patches + any patches, where to find them and how to apply + them How to configure and compile the source code Where on the target machine to install the - package or packages being compiled + package or packages created @@ -228,7 +229,10 @@ The term "package" is also commonly used to describe recipes. However, since the same word is used to describe packaged output from a project, it is best to maintain a single - descriptive term, "recipes". + descriptive term, "recipes". Put another way, a single + "recipe" file is quite capable of generating a number of + related but separately installable "packages"; this is + actually fairly common. @@ -248,7 +252,7 @@ The main configuration file is the sample bitbake.conf file, which is located within the BitBake source tree - conf directory. + conf/ directory. @@ -262,7 +266,7 @@ The BitBake source tree currently comes with one class metadata file called base.bbclass. You can find this file in the - classes directory. + classes/ directory. The base.bbclass class files is special since it is always included automatically for all recipes and classes. @@ -313,7 +317,6 @@ Append files, which are files that have the .bbappend file extension, extend or override information in an existing recipe file. - recipe file. @@ -326,8 +329,8 @@ - Information in append files overrides the information in the - similarly-named recipe file. + Information in append files extends or overrides the information in the + underlying, similarly-named recipe file. @@ -352,6 +355,12 @@ However, if you named the append file busybox_1.%.bbappend, then you would have a match. + + + In the most general case, you could name the append file something as + simple as busybox_%.bbappend to be entirely + version independent. + @@ -359,7 +368,7 @@ Obtaining BitBake - You can obtain BitBake several different ways: + You can obtain BitBake in one of several different ways: Cloning BitBake: Using Git to clone the BitBake source code repository @@ -432,7 +441,7 @@ has been thoroughly tested for compatibility with the other components. For information on how to check out a particular BitBake-based - build system, the build system's supporting documentation. + build system, consult that build system's supporting documentation. -- ======================================================================== Robert P. J. Day Ottawa, Ontario, CANADA http://crashcourse.ca Twitter: http://twitter.com/rpjday LinkedIn: http://ca.linkedin.com/in/rpjday ========================================================================