Patchwork [bitbake-devel] Documentation: A few tweaks to Chapter 2, BitBake User Manual

login
register
mail settings
Submitter Robert P. J. Day
Date July 8, 2014, 2:10 p.m.
Message ID <alpine.LFD.2.11.1407081010150.14336@localhost>
Download mbox | patch
Permalink /patch/75177/
State New
Headers show

Comments

Robert P. J. Day - July 8, 2014, 2:10 p.m.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

  only questionable part is my example of busybox supplying two
versions, perhaps that's outside the scope of this manual.


rday
Rifenbark, Scott M - July 8, 2014, 7:05 p.m.
Applied.  Needs merged into BB repo.

Scott

>-----Original Message-----
>From: bitbake-devel-bounces@lists.openembedded.org [mailto:bitbake-
>devel-bounces@lists.openembedded.org] On Behalf Of Robert P. J. Day
>Sent: Tuesday, July 08, 2014 7:11 AM
>To: BitBake developer list
>Subject: [bitbake-devel] [PATCH] Documentation: A few tweaks to Chapter 2,
>BitBake User Manual
>
>
>Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
>---
>
>  only questionable part is my example of busybox supplying two versions,
>perhaps that's outside the scope of this manual.
>
>diff --git a/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
>b/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
>index 8b6e0b4..403ad5b 100644
>--- a/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
>+++ b/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
>@@ -7,7 +7,8 @@
>     <para>
>         The primary purpose for running BitBake is to produce some kind
>         of output such as a single installable package, a kernel, a software
>-        development kit, or even a full, board-specific bootable Linux image.
>+        development kit, or even a full, board-specific bootable Linux image,
>+        complete with bootloader, kernel and root filesystem.
>         Of course, you can execute the <filename>bitbake</filename>
>         command with options that cause it to execute single tasks,
>         compile single recipe files, capture or clear data, or simply @@ -45,6
>+46,11 @@
>                 build host with hyper-threading will most likely show eight
>processors,
>                 which is the value you would then assign to that variable.
>             </para>
>+
>+            <para>
>+                A possibly simpler solution is that some Linux distributions
>+                (Debian, Ubuntu) provide the <filename>ncpus</filename>
>command.
>+            </para>
>         </note>
>     </para>
>
>@@ -84,7 +90,7 @@
>             <link linkend='var-BBFILES'><filename>BBFILES</filename></link>.
>             <filename>BBPATH</filename> is used to search for
>             configuration and class files under the
>-            <filename>conf</filename> and <filename>classes</filename>
>+            <filename>conf/</filename> and
>+ <filename>classes/</filename>
>             directories, respectively.
>             <filename>BBFILES</filename> is used to locate both recipe
>             and recipe append files
>@@ -464,6 +470,29 @@
>      PREFERRED_VERSION_a = "1.1"
>             </literallayout>
>         </para>
>+
>+        <note>
>+            <para>
>+                It's common for a recipe to provide two versions -- a stable,
>+                numbered (and preferred) version, and a version that is
>+                automatically checked out from a source code repository that
>+                is considered more "bleeding edge" but can be selected only
>+                explicitly.
>+            </para>
>+
>+            <para>
>+                For example, in the OpenEmbedded codebase, there is a standard,
>+                versioned recipe file for BusyBox,
>+                <filename>busybox_1.22.1.bb</filename>,
>+                but there is also a Git-based version,
>+                <filename>busybox_git.bb</filename>, which explicitly contains the
>line
>+                <literallayout class='monospaced'>
>+    DEFAULT_PREFERENCE = "-1"
>+                </literallayout>
>+                to ensure that the numbered, stable version is always preferred
>+                unless the developer selects otherwise.
>+            </para>
>+        </note>
>     </section>
>
>     <section id='bb-bitbake-dependencies'>
>
>rday
>
>--
>
>===========================================================
>=============
>Robert P. J. Day                                 Ottawa, Ontario, CANADA
>                        http://crashcourse.ca
>
>Twitter:                                       http://twitter.com/rpjday
>LinkedIn:                               http://ca.linkedin.com/in/rpjday
>===========================================================
>=============
>--
>_______________________________________________
>bitbake-devel mailing list
>bitbake-devel@lists.openembedded.org
>http://lists.openembedded.org/mailman/listinfo/bitbake-devel

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-execution.xml b/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
index 8b6e0b4..403ad5b 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-execution.xml
@@ -7,7 +7,8 @@ 
     <para>
         The primary purpose for running BitBake is to produce some kind
         of output such as a single installable package, a kernel, a software
-        development kit, or even a full, board-specific bootable Linux image.
+        development kit, or even a full, board-specific bootable Linux image,
+        complete with bootloader, kernel and root filesystem.
         Of course, you can execute the <filename>bitbake</filename>
         command with options that cause it to execute single tasks,
         compile single recipe files, capture or clear data, or simply
@@ -45,6 +46,11 @@ 
                 build host with hyper-threading will most likely show eight processors,
                 which is the value you would then assign to that variable.
             </para>
+
+            <para>
+                A possibly simpler solution is that some Linux distributions
+                (Debian, Ubuntu) provide the <filename>ncpus</filename> command.
+            </para>
         </note>
     </para>

@@ -84,7 +90,7 @@ 
             <link linkend='var-BBFILES'><filename>BBFILES</filename></link>.
             <filename>BBPATH</filename> is used to search for
             configuration and class files under the
-            <filename>conf</filename> and <filename>classes</filename>
+            <filename>conf/</filename> and <filename>classes/</filename>
             directories, respectively.
             <filename>BBFILES</filename> is used to locate both recipe
             and recipe append files
@@ -464,6 +470,29 @@ 
      PREFERRED_VERSION_a = "1.1"
             </literallayout>
         </para>
+
+        <note>
+            <para>
+                It's common for a recipe to provide two versions -- a stable,
+                numbered (and preferred) version, and a version that is
+                automatically checked out from a source code repository that
+                is considered more "bleeding edge" but can be selected only
+                explicitly.
+            </para>
+
+            <para>
+                For example, in the OpenEmbedded codebase, there is a standard,
+                versioned recipe file for BusyBox,
+                <filename>busybox_1.22.1.bb</filename>,
+                but there is also a Git-based version,
+                <filename>busybox_git.bb</filename>, which explicitly contains the line
+                <literallayout class='monospaced'>
+    DEFAULT_PREFERENCE = "-1"
+                </literallayout>
+                to ensure that the numbered, stable version is always preferred
+                unless the developer selects otherwise.
+            </para>
+        </note>
     </section>

     <section id='bb-bitbake-dependencies'>