Skip to contentSkip to conversation

Poky Reference Manual changes

PATCH Applied [email protected] 2 participants 17 messages Mar 18, 2011

lore
Share & tools
lore
#0 lore raw

cover Poky Reference Manual changes

From: Scott Rifenbark <[email protected]>

These commits are the changes for the Poky Reference Manual. Some bugs taken care of, spell-checks, title page updates, grammar fixes, FAQ entries, formfactor path fix.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/poky-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/poky-work

Thanks,
<[email protected]>
---

Scott Rifenbark (15):
[BUGID# 873] - documentation/poky-ref-manual: Notes added for
non-GPLv3 builds
[BUGID# 293] - documentation/poky-ref-manual/extendpoky.xml: Added
text for choosing server
documentation/poky-ref-manual/extendpoky.xml: Spell check documentation/poky-ref-manual/style.css: Updated to match other
manuals
documentation/poky-ref-manual/poky-ref-manual.xml: Updated title page documentation/poky-ref-manual/faq.xml: Spell Check documentation/poky-ref-manual/introduction.xml: Removed link documentation/poky-ref-manual/introduction.xml: Wording and release
update
documentation/poky-ref-manual/usingpoky.xml: grammar fix and BitBake
fix
documentation/poky-ref-manual/usingpoky.xml: More BitBake changes documentation/poky-ref-manual/faq.xml: Added three FAQ entries documentation/poky-ref-manual/usingpoky.xml: Small edits documentation/poky-ref-manual/extendpoky.xml: small edits documentation/poky-ref-manual/extendpoky.xml: Formfactor path
corrected
documentation/poky-ref-manual/faq.xml: Added entry about proxy and
firewall

 documentation/poky-ref-manual/extendpoky.xml      |   67 +++++----
 documentation/poky-ref-manual/faq.xml             |  174 ++++++++++++++++++++-
 documentation/poky-ref-manual/introduction.xml    |   11 +-
 documentation/poky-ref-manual/poky-ref-manual.xml |    5 +
 documentation/poky-ref-manual/ref-images.xml      |   12 ++
 documentation/poky-ref-manual/style.css           |   22 ++-
 documentation/poky-ref-manual/usingpoky.xml       |   63 ++++----
 7 files changed, 279 insertions(+), 75 deletions(-)
#1 lore raw

PATCH 1/15 - documentation/poky-ref-manual: Notes added for non-GPLv3 builds

From: Scott Rifenbark <[email protected]>

[BUGID# 873] - Added a note in the Images Appendix indicating that building an image without GPLv3 components is only supported for base and minimal images. Also put the two changes you have to do to the local.conf file for the build.

Added a note in the second chapter in the section on building images. The note indicates the same as in the appendix but does not go into the local.conf file detail.

---
 documentation/poky-ref-manual/ref-images.xml |   12 ++++++++++++
 documentation/poky-ref-manual/usingpoky.xml  |    7 ++++++-
 2 files changed, 18 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/ref-images.xml +12 -0
index 9477883..03cc624 100644
@@ -13,6 +13,18 @@
         Images are listed below along with details of what they contain:
     </para>
 
+    <note>
+        Building an image without GNU Public License Version 3 (GPLv3) components is 
+        only supported for minimal and base images.
+        Furthermore, if you are going to build an image using non-GPLv3 components,
+        you must make the following changes in the <filename>local.conf</filename> file
+        before using the BitBake command to build the minimal or base image:
+        <literallayout class='monospaced'>
+     1. Comment out the IMAGE_EXTRA_FEATURES line
+     2. Set INCOMPATIBLE_LICENSE = "GPLv3"
+        </literallayout>
+    </note>
+
     <itemizedlist>
             <listitem>
                 <para>
documentation/poky-ref-manual/usingpoky.xml +6 -1
index 79e9dfb..aecefd3 100644
@@ -151,13 +151,18 @@
     </para>
     <para>
         The target is the name of the recipe you want to build. 
-        Common targets are the images in <filename>meta/recipes-core/images</filename>),
+        Common targets are the images in <filename>meta/recipes-core/images</filename>,
         <filename>/meta/recipes-sato/images</filename>, etc.
         Or, the target can be the name of a recipe for a specific piece of software such as 
         <application>busybox</application>. 
         For more details about the standard images available, see the 
         <link linkend="ref-images">'Reference: Images'</link> appendix.
     </para>
+    <note>
+        Building an image without GNU Public License Version 3 (GPLv3) components is 
+        only supported for minimal and base images.
+        See <link linkend='ref-images'>'Reference: Images'</link> for more information.
+    </note>
 </section>
 
 <section id='usingpoky-install'>
Signature · 1 line
1.7.1
#2 lore raw

PATCH 2/15 - documentation/poky-ref-manual/extendpoky.xml: Added text for choosing server

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

[BUGID# 293] - I added text at the end of section 3.2.3 "Customizing Images Using Custom IMAGE_FEATURES" to include explanation of the two servers Poky uses for images by default. Also how to change the variable IMAGE_FEATURES to configure the server. This change is part of the fix for BUGID# 293 and was suggested by Scott Garman.

---
 documentation/poky-ref-manual/extendpoky.xml |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
documentation/poky-ref-manual/extendpoky.xml +10 -0
index 182b36d..d7d2c6c 100644
@@ -364,6 +364,16 @@ RRECOMMENDS_task-custom-tools = "\
                 Users can add extra features by extending the class or creating a custom class for use 
                 with specialized image <filename>.bb</filename> files.
             </para>
+            <para>
+                Poky ships with two SSH servers you can use in your images: Dropbear and OpenSSH. 
+                Dropbear is a minimal SSH server appropriate for resource-constrained environments,
+                while OpenSSH is a well-known standard SSH server implementation.
+                By default, poky-image-sato is configured to use Dropbear.
+                The poky-image-basic and poky-image-lsb images both include OpenSSH.
+                To change these defaults, edit the <filename>IMAGE_FEATURES</filename> variable
+                so that it sets the image you are working with to include ssh-server-dropbear 
+                or ssh-server-openssh.
+            </para>
         </section>
 
         <section id='usingpoky-extend-customimage-localconf'>
Signature · 1 line
1.7.1
#3 lore raw

PATCH 3/15 documentation/poky-ref-manual/extendpoky.xml: Spell check

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

A spell check performed on this chapter.

---
 documentation/poky-ref-manual/extendpoky.xml |   30 +++++++++++++-------------
 1 files changed, 15 insertions(+), 15 deletions(-)
documentation/poky-ref-manual/extendpoky.xml +15 -15
index d7d2c6c..951468d 100644
@@ -46,7 +46,7 @@
                 "do_install" tasks.
                 The <glossterm><link linkend='var-S'>S</link></glossterm> variable defines the 
                 directory containing the source code, which is set to <glossterm><link linkend='var-WORKDIR'>
-                WORKDIR</link></glossterm> in this case - the directory Bitbake uses for the build.
+                WORKDIR</link></glossterm> in this case - the directory BitBake uses for the build.
             </para>
             <programlisting>
 DESCRIPTION = "Simple helloworld application"
@@ -68,7 +68,7 @@ do_install() {
 }
             </programlisting>
             <para>
-                By default, the "helloworld", "helloworld-dbg" and "hellworld-dev"
+                By default, the "helloworld", "helloworld-dbg" and "helloworld-dev"
                 packages are built. 
                 For information on how to customize the packaging process, see
                 <link linkend='usingpoky-extend-addpkg-files'>Controlling Package Content</link>.
@@ -81,7 +81,7 @@ do_install() {
                 Applications that use autotools such as <filename>autoconf</filename> and 
                 <filename>automake</filename> require a recipe that has a source archive listed in 
                 <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm> and 
-                <filename>also inherits autotools</filename>, which instructs Bitbake to use the
+                <filename>also inherits autotools</filename>, which instructs BitBake to use the
                 <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps
                 needed to build an autotooled application.
                 The result of the build is automatically packaged. 
@@ -114,13 +114,13 @@ inherit autotools gettext
             <para>
                 Applications that use GNU <filename>make</filename> also require a recipe that has
                 the source archive listed in <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm>. 
-                You do not need to add a <function>do_compile</function> step since by default Bitbake 
+                You do not need to add a <function>do_compile</function> step since by default BitBake 
                 starts the <filename>make</filename> command to compile the application. 
                 If you need additional <filename>make</filename> options you should store them in the 
                 <glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm> variable.
-                Bitbake passes these options into the <filename>make</filename> GNU invocation. 
+                BitBake passes these options into the <filename>make</filename> GNU invocation. 
                 Note that a "do_install" task is still required.
-                Otherwise Bitbake runs an empty "do_install" task by default. 
+                Otherwise BitBake runs an empty "do_install" task by default. 
             </para>
             <para>
                 Some applications might require extra parameters to be passed to the compiler.
@@ -529,7 +529,7 @@ DISPLAY_SUBPIXEL_ORDER=vrgb
     <section id="usingpoky-changes">
         <title>Making and Maintaining Changes</title>
         <para>
-            Because Poky offers extreme configurability and flexibility, we recognize that people will want 
+            Because Poky is extremely configurable and flexible, we recognize that people will want 
             to extend, configure or optimize Poky for their specific uses.
             To best keep pace with future Poky changes we recommend you make controlled changes to Poky.
         </para>
@@ -541,12 +541,12 @@ DISPLAY_SUBPIXEL_ORDER=vrgb
         </para>
 
         <section id="usingpoky-changes-layers">
-          <title>Bitbake Layers</title>
+          <title>BitBake Layers</title>
           <para>
                 Often, people want to extend Poky either by adding packages
                 or by overriding files contained within Poky to add their own
                 functionality. 
-                Bitbake has a powerful mechanism called
+                BitBake has a powerful mechanism called
                 "layers", which provides a way to handle this extension in a fully
                 supported and non-invasive fashion.
            </para>
@@ -575,7 +575,7 @@ BBLAYERS = " \
            </para>
 
           <para>
-               Bitbake parses each <filename>conf/layer.conf</filename> file for each layer in BBLAYERS
+               BitBake parses each <filename>conf/layer.conf</filename> file for each layer in BBLAYERS
                and adds the recipes, classes and configuration contained within the layer to Poky.
                To create your own layer, independent of the main Poky repository,
                simply create a directory with a <filename>conf/layer.conf</filename> file and
@@ -613,14 +613,14 @@ BBFILE_PRIORITY_emenlow = "6"
                 Note the use of the <glossterm><link linkend='var-LAYERDIR'>LAYERDIR</link></glossterm> 
                 variable with the immediate expansion operator.
                 The LAYERDIR variable expands to the directory of the current layer and
-                requires the immediate expansion operator so that Bitbake does not wait to expand the variable 
+                requires the immediate expansion operator so that BitBake does not wait to expand the variable 
                 when it's parsing a different directory.
             </para>
             <para>
-                Bitbake can locate where other bbclass and configuration files are applied through 
+                BitBake can locate where other bbclass and configuration files are applied through 
                 the <glossterm><link linkend='var-BBPATH'>BBPATH</link></glossterm>
                 environment variable. 
-                For these cases, Bitbake uses the first file with the matching name found in BBPATH.
+                For these cases, BitBake uses the first file with the matching name found in BBPATH.
                 This is similar to the way the PATH variable is used for binaries. 
                 We recommend, therefore, that you use unique bbclass and configuration file names in your
                 custom layer.
@@ -747,7 +747,7 @@ BBFILE_PRIORITY_emenlow = "6"
             <para>
                 The core component of any development effort with Poky is often an 
                 automated build testing framework and an image generation process. 
-                You can use these core components to check that the metadata is buildable, 
+                You can use these core components to check that the metadata can be built, 
                 highlight when commits break the build, and provide up-to-date images that 
                 allow people to test the end result and use it as a base platform for further 
                 development. 
@@ -969,7 +969,7 @@ LIC_FILES_CHKSUM = "file://../license.html;md5=5c94767cedb5d6987c902ac850ded2c6"
                 This practice allow you to just track the "COPYING" file as long as it is kept up to date. 
             </para>
             <tip>
-                If you specify an empty or invalid "md5" parameter, Bitbake returns an md5 mis-match 
+                If you specify an empty or invalid "md5" parameter, BitBake returns an md5 mis-match 
                 error and displays the correct "md5" parameter value during the build. The correct parameter
                 is also captured in the build log. 
             </tip>
Signature · 1 line
1.7.1
#4 lore raw

PATCH 4/15 documentation/poky-ref-manual/style.css: Updated to match other manuals

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

I have updated some styles so that the GIT manuals are looking more consistent and have better color schemes for the section headings.

---
 documentation/poky-ref-manual/style.css |   22 ++++++++++++++--------
 1 files changed, 14 insertions(+), 8 deletions(-)
documentation/poky-ref-manual/style.css +14 -8
index 3564aff..138d485 100644
@@ -50,9 +50,13 @@ body {
   color: #333;
 }
 
+.reviewer {
+  color: red;
+}
+
 h1,h2,h3,h4,h5,h6,h7 {
   font-family: Arial, Sans;
-  color:#999999;
+  color: #00557D;
   clear: both;
 }
 
@@ -76,7 +80,7 @@ h2 {
   margin: 2em 0em 0.66em 0em;
   padding: 0.5em 0em 0em 0em;
   font-size: 1.5em;
-  font-weight: normal;
+  font-weight: bold;
 }
 
 h3.subtitle {
@@ -90,28 +94,28 @@ h3 {
   margin: 1em 0em 0.5em 0em;
   padding: 1em 0em 0em 0em;
   font-size: 140%;
-  font-weight: normal;
+  font-weight: bold;
 }
 
 h4 {
   margin: 1em 0em 0.5em 0em;
   padding: 1em 0em 0em 0em;
   font-size: 120%;
-  font-weight: normal;
+  font-weight: bold;
 }
 
 h5 {
   margin: 1em 0em 0.5em 0em;
   padding: 1em 0em 0em 0em;
-  font-size: 110.000%;
-  border-bottom: 1px solid black;
+  font-size: 110%;
+  font-weight: bold;
 }
 
 h6 {
   margin: 1em 0em 0em 0em;
   padding: 1em 0em 0em 0em;
   font-size: 80%;
-  font-weight: normal;
+  font-weight: bold;
 }
 
 .authorgroup {
@@ -132,6 +136,7 @@ h3.author {
   padding: 0em 0em 0em 0em;
   font-weight: normal;
   font-size: 100%;
+  color: #333;
   clear: both;
 }
 
@@ -154,6 +159,7 @@ h3.author {
 .list-of-examples,
 .list-of-figures {
   padding: 1.33em 0em 2.5em 0em;
+  color: #00557D;
 }
 
 .toc p,
@@ -930,7 +936,7 @@ table {
 
 .tip,
 .note {
-   background: #91ae35;
+   background: #666666;
    color: #fff;   
    padding: 20px;
    margin: 20px;
Signature · 1 line
1.7.1
#5 lore raw

PATCH 5/15 documentation/poky-ref-manual/poky-ref-manual.xml: Updated title page

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

Updated the title page by adding a new revision entry for the manual. Not sure of the current revision numbering scheme so I reset it to Revision 1.0 to match that of the release.

---
 documentation/poky-ref-manual/poky-ref-manual.xml |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)
documentation/poky-ref-manual/poky-ref-manual.xml +5 -0
index b4d7757..ed720c4 100644
@@ -47,6 +47,11 @@
                 <date>24 November 2010</date>
                 <revremark>Poky Master Documentation</revremark>
             </revision>
+            <revision>
+                <revnumber>1.0</revnumber>
+                <date>6 April 2011</date>
+                <revremark>Poky documentation releasing with the Yocto Project 1.0 Release.</revremark>
+            </revision>
         </revhistory>
 
     <copyright>
Signature · 1 line
1.7.1
#6 lore raw

PATCH 6/15 documentation/poky-ref-manual/faq.xml: Spell Check

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

Performed a spell check and corrected several problems.

---
 documentation/poky-ref-manual/faq.xml |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)
documentation/poky-ref-manual/faq.xml +5 -5
index 03ae714..96e32d5 100644
@@ -108,7 +108,7 @@
                 </listitem>
                 <listitem>
                     <para>
-                    Send us bitbake recipes if you have them (see the Poky handbook to find out how to create recipes)
+                    Send us BitBake recipes if you have them (see the Poky handbook to find out how to create recipes)
                     </para>
                 </listitem>
             </itemizedlist>
@@ -148,7 +148,7 @@
         </question>
         <answer>
             <para>
-                To add a package you need to create a bitbake recipe - see the Poky handbook to find out how to create a recipe.
+                To add a package you need to create a BitBake recipe - see the Poky handbook to find out how to create a recipe.
             </para>
         </answer>
     </qandaentry>
@@ -332,19 +332,19 @@
         </question>
         <answer>
             <para>
-                If the same build is failing in totally different and random ways the most likely explaination is that either the hardware you're running it on has some problem or if you are running it under virtualisation, the virtualisation probably has bugs. Poky processes a massive amount of data causing lots of network, disk and cpu activity and is senstive to even single bit failure in any of these areas. Totally random failures have always been traced back to hardware or virtualisation issues.
+                If the same build is failing in totally different and random ways the most likely explanation is that either the hardware you're running it on has some problem or if you are running it under virtualisation, the virtualisation probably has bugs. Poky processes a massive amount of data causing lots of network, disk and cpu activity and is sensitive to even single bit failure in any of these areas. Totally random failures have always been traced back to hardware or virtualisation issues.
             </para>
         </answer>
     </qandaentry>
     <qandaentry>
         <question>
             <para>
-                What do we need to ship for licence complience?
+                What do we need to ship for license compliance?
             </para>
         </question>
         <answer>
             <para>
-                This is a difficult question and you need to consult your lawyer for the answer for your specific case. Its worth bearing in mind that for GPL complience there needs to be enough information shipped to allow someone else to rebuild the same end result as you are shipping. This means sharing the source code, any patches applied to it but also any configuration information about how that package was configured and built.
+                This is a difficult question and you need to consult your lawyer for the answer for your specific case. Its worth bearing in mind that for GPL compliance there needs to be enough information shipped to allow someone else to rebuild the same end result as you are shipping. This means sharing the source code, any patches applied to it but also any configuration information about how that package was configured and built.
             </para>
         </answer>
     </qandaentry>
Signature · 1 line
1.7.1
#7 lore raw

PATCH 7/15 documentation/poky-ref-manual/introduction.xml: Removed link

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

Removed a link to the Intel Website. Upon testing this link I discovered that it loads the Intel site into the current web page and then disables the back button. Rather annoying. I tried to change the link to pop a new window but couldn't get the ulink.target parameter to work. Ran out of time to try and figure it out so I removed the link.

---
 documentation/poky-ref-manual/introduction.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/introduction.xml +1 -1
index 59c6eea..1701713 100644
@@ -69,7 +69,7 @@
 
     <para>
         Poky has a growing open source community and is also backed up by commercial organizations 
-        including <ulink url="http://www.intel.com/">Intel Corporation</ulink>.
+        including Intel&reg; Corporation.
     </para>
 </section>
 
Signature · 1 line
1.7.1
#8 lore raw

PATCH 8/15 documentation/poky-ref-manual/introduction.xml: Wording and release update

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

I changed several occurances of "Yocto Project" to "the Yocto Project." Also changed the statement about what Poky release the book supported. It previously said "applies to Poky Release 4.0 (Laverne)." I changed this to "applies to Poky Release 5.0 (Bernard)."

---
 documentation/poky-ref-manual/introduction.xml |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)
documentation/poky-ref-manual/introduction.xml +5 -4
index 1701713..90eaf01 100644
@@ -8,8 +8,8 @@
     <title>Welcome to Poky!</title>
 
     <para>
-        Poky is the build tool in Yocto Project.
-        Yocto Project uses Poky to build images (kernel, system, and application software) for 
+        Poky is the build tool in the Yocto Project.
+        The Yocto Project uses Poky to build images (kernel, system, and application software) for 
         targeted hardware.
     </para>
 
@@ -78,7 +78,8 @@
     <para>
         The sections in this reference manual describe different aspects of Poky. 
         The <link linkend='usingpoky'>'Using Poky'</link> section provides an overview of the components 
-        that make up Poky followed by information about using Poky and debugging images created in Yocto Project. 
+        that make up Poky followed by information about using Poky and debugging images created in 
+        the Yocto Project. 
         The <link linkend='extendpoky'>'Extending Poky'</link> and 
         <link linkend='bsp'>'Board Support Packages'</link> sections provide information 
         about how to extend and customize Poky along with advice on how to manage these changes. 
@@ -90,7 +91,7 @@
     </para>
 
     <para>
-        This manual applies to Poky Release 4.0 (laverne).
+        This manual applies to Poky Release 5.0 (Bernard).
     </para>
 </section>
 
Signature · 1 line
1.7.1
#9 lore raw

PATCH 9/15 documentation/poky-ref-manual/usingpoky.xml: grammar fix and BitBake fix

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

Fixed a grammar problem and then did a search and replace for "bitbake" to replace with "BitBake".

---
 documentation/poky-ref-manual/usingpoky.xml |   32 +++++++++++++-------------
 1 files changed, 16 insertions(+), 16 deletions(-)
documentation/poky-ref-manual/usingpoky.xml +16 -16
index aecefd3..f27b349 100644
@@ -5,7 +5,7 @@
 
     <para>
         This section gives an overview of the components that make up Poky 
-        following by information about running poky builds and dealing with any
+        followed by information about running poky builds and dealing with any
         problems that may arise.
     </para>
 
@@ -13,8 +13,8 @@
     <title>Poky Overview</title>
 
     <para>
-        The bitbake task executor together with various types of configuration files form the core of Poky.
-        This section overviews the bitbake task executor and the
+        The BitBake task executor together with various types of configuration files form the core of Poky.
+        This section overviews the BitBake task executor and the
         configuration files by describing what they are used for and they they interact.
     </para>
     
@@ -48,12 +48,12 @@
         <para>
             Bitbake is the tool at the heart of Poky and is responsible
             for parsing the metadata, generating a list of tasks from it
-            and then executing them. To see a list of the options bitbake
+            and then executing them. To see a list of the options BitBake
             supports look at 'bitbake --help'.
         </para>
 
         <para>
-            The most common usage for bitbake is <filename>bitbake &lt;packagename&gt;</filename>, where
+            The most common usage for BitBake is <filename>bitbake &lt;packagename&gt;</filename>, where
             packagename is the name of the package you want to build (referred to as the 'target'
             in this manual). 
             The target often equates to the first part of a <filename>.bb</filename> filename.
@@ -64,13 +64,13 @@
             </literallayout>
             Several different versions of <filename>matchbox-desktop</filename> might exist.
             Bitbake chooses the one selected by the distribution configuration.
-            You can get more details about how bitbake chooses between different versions
+            You can get more details about how BitBake chooses between different versions
             and providers in the <link linkend='ref-bitbake-providers'>
             'Preferences and Providers'</link> section.
         </para>
         <para>
             Bitbake also tries to execute any dependent tasks first.
-            So for example, before building <filename>matchbox-desktop</filename> bitbake
+            So for example, before building <filename>matchbox-desktop</filename> BitBake
             would build a cross compiler and glibc if they had not already been built.
         </para>
 
@@ -202,7 +202,7 @@
         <para>The log file for shell tasks is available in <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>. 
             For example, the "compile" task of busybox 1.01 on the ARM spitz machine might be 
             <filename>tmp/work/armv5te-poky-linux-gnueabi/busybox-1.01/temp/log.do_compile.1234</filename>.
-            To see what bitbake runs to generate that log, look at the corresponding 
+            To see what BitBake runs to generate that log, look at the corresponding 
             <filename>run.do_taskname.pid </filename> file located in the same directory.
         </para>
 
@@ -219,10 +219,10 @@
             In most cases the series is: fetch, unpack, patch, configure,
             compile, install, package, package_write and build. 
             The default task is "build" and any tasks on which it depends build first - hence, 
-            the standard bitbake behaviour. 
+            the standard BitBake behaviour. 
             Some tasks exist, such as devshell, that are not part of the default build chain.  
             If you wish to run a task that is not part of the default build chain you can use the 
-            "-c" option in bitbake as follows:
+            "-c" option in BitBake as follows:
             <literallayout class='monospaced'>
      $ bitbake matchbox-desktop -c devshell
             </literallayout>
@@ -264,7 +264,7 @@
         <title>Dependency Graphs</title>
 
         <para>
-            Sometimes it can be hard to see why bitbake wants to build some other packages before a given 
+            Sometimes it can be hard to see why BitBake wants to build some other packages before a given 
             package you've specified.
             The <filename>bitbake -g targetname</filename> command creates the <filename>depends.dot</filename> and
             <filename>task-depends.dot</filename> files in the current directory. 
@@ -278,8 +278,8 @@
         <title>General Bitbake Problems</title>
 
         <para>
-            You can see debug output from bitbake by using the "-D" option.
-            The debug output gives more information about what bitbake
+            You can see debug output from BitBake by using the "-D" option.
+            The debug output gives more information about what BitBake
             is doing and the reason behind it. 
             Each "-D" option you use increases the logging level.
             The most common usage is <filename>-DDD</filename>.
@@ -287,9 +287,9 @@
 
         <para>
             The output from <filename>bitbake -DDD -v targetname</filename> can reveal why
-            bitbake chose a certain version of a package or why bitbake
+            BitBake chose a certain version of a package or why BitBake
             picked a certain provider.
-            This command could also help you in a situation where you think bitbake did something 
+            This command could also help you in a situation where you think BitBake did something 
             unexpected.
         </para>
     </section>
@@ -301,7 +301,7 @@
             the command form <filename>bitbake -b somepath/somefile.bb</filename>. 
             This command form does not check for dependencies so you should use it
             only when you know its dependencies already exist. 
-            You can also specify fragments of the filename and bitbake checks for a unique match.
+            You can also specify fragments of the filename and BitBake checks for a unique match.
         </para>
     </section>
 
Signature · 1 line
1.7.1
#10 lore raw

PATCH 10/15 documentation/poky-ref-manual/usingpoky.xml: More BitBake changes

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

Forgot to search for "Bitbake" occurances. These are now changed to "BitBake."

---
 documentation/poky-ref-manual/usingpoky.xml |   16 ++++++++--------
 1 files changed, 8 insertions(+), 8 deletions(-)
documentation/poky-ref-manual/usingpoky.xml +8 -8
index f27b349..70ed309 100644
@@ -19,7 +19,7 @@
     </para>
     
     <para>  
-        Bitbake handles the parsing and execution of the data files. 
+        BitBake handles the parsing and execution of the data files. 
         The data itself is of various types:
     <itemizedlist>
         <listitem><para>Recipes:  Provides details about particular pieces of software</para></listitem>
@@ -31,7 +31,7 @@
     </para>
 
     <para> 
-        Bitbake knows how to combine multiple data sources together and refers to each data source
+        BitBake knows how to combine multiple data sources together and refers to each data source
         as a <link linkend='usingpoky-changes-layers'>'layer'</link>.
     </para>
 
@@ -43,10 +43,10 @@
     </para>
 
     <section id='usingpoky-components-bitbake'>
-        <title>Bitbake</title>
+        <title>BitBake</title>
 
         <para>
-            Bitbake is the tool at the heart of Poky and is responsible
+            BitBake is the tool at the heart of Poky and is responsible
             for parsing the metadata, generating a list of tasks from it
             and then executing them. To see a list of the options BitBake
             supports look at 'bitbake --help'.
@@ -63,13 +63,13 @@
      $ bitbake matchbox-desktop
             </literallayout>
             Several different versions of <filename>matchbox-desktop</filename> might exist.
-            Bitbake chooses the one selected by the distribution configuration.
+            BitBake chooses the one selected by the distribution configuration.
             You can get more details about how BitBake chooses between different versions
             and providers in the <link linkend='ref-bitbake-providers'>
             'Preferences and Providers'</link> section.
         </para>
         <para>
-            Bitbake also tries to execute any dependent tasks first.
+            BitBake also tries to execute any dependent tasks first.
             So for example, before building <filename>matchbox-desktop</filename> BitBake
             would build a cross compiler and glibc if they had not already been built.
         </para>
@@ -246,7 +246,7 @@
         <para>
             This sequence first builds <filename>matchbox-desktop</filename> and then recompiles it.
             The last command reruns all tasks, basically the packaging tasks, after the compile.
-            Bitbake recognizes that the "compile" task was rerun and therefore understands that the other
+            BitBake recognizes that the "compile" task was rerun and therefore understands that the other
             tasks also need to be run again.
         </para>
 
@@ -275,7 +275,7 @@
     </section>
 
     <section id='usingpoky-debugging-bitbake'>
-        <title>General Bitbake Problems</title>
+        <title>General BitBake Problems</title>
 
         <para>
             You can see debug output from BitBake by using the "-D" option.
Signature · 1 line
1.7.1
#11 lore raw

PATCH 11/15 documentation/poky-ref-manual/faq.xml: Added three FAQ entries

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

Added three FAQ entries per Joshual Lock.

1. How do I disable the cursor on my touchscreen device?
2. How do I make sure connected network interfaces are brought up by default.
3. How do I create images with more free space?

---
 documentation/poky-ref-manual/faq.xml |   68 +++++++++++++++++++++++++++++++++
 1 files changed, 68 insertions(+), 0 deletions(-)
documentation/poky-ref-manual/faq.xml +68 -0
index 96e32d5..366db6c 100644
@@ -348,6 +348,74 @@
             </para>
         </answer>
     </qandaentry>
+
+    <qandaentry>
+        <question>
+            <para>
+                How do I disable the cursor on my touchscreen device?
+            </para>
+        </question>
+        <answer>
+            <para>
+                You need to create a form factor file as described in 
+                <xref linkend='bsp-filelayout-misc-recipes'>"Miscellaneous Recipe Files"</xref>
+                and set the <filename>HAVE_TOUCHSCREEN</filename> variable equal to one.
+                <literallayout class='monospaced'>
+     HAVE_TOUCHSCREEN=1
+                </literallayout>
+            </para>
+        </answer>
+    </qandaentry>
+
+    <qandaentry>
+        <question>
+            <para>
+                How do I make sure connected network interfaces are brought up by default?
+            </para>
+        </question>
+        <answer>
+            <para>
+                The default interfaces file provided by the netbase recipe does not 
+                automatically bring up network interfaces. 
+                Therefore you will need to add a BSP-specific netbase that includes an interfaces 
+                file.
+                See <xref linkend='bsp-filelayout-misc-recipes'>"Miscellaneous Recipe Files"</xref>
+                for information on creating these types of miscellaneous recipe files.
+            </para>
+            <para>
+                For example, add the following files to your layer:
+                <literallayout class='monospaced'>
+     meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces
+     meta-MACHINE/recipes-bsp/netbase/netbase_4.44.bbappend
+                </literallayout>
+            </para>
+        </answer>
+    </qandaentry>
+
+    <qandaentry>
+        <question>
+            <para>
+                How do I create images with more free space?
+            </para>
+        </question>
+        <answer>
+            <para>
+                Images are created to be 1.2 times the size of the populated root filesystem. 
+                To modify this ratio so that there is more free space available you need to 
+                set the configuration value <filename>IMAGE_OVERHEAD_FACTOR</filename>.  
+                For example, setting <filename>IMAGE_OVERHEAD_FACTOR</filename> to 1.5 sets 
+                the image size ratio to one and a half times the size of the populated 
+                root filesystem.
+                <literallayout class='monospaced'>
+     IMAGE_OVERHEAD_FACTOR = "1.5"
+                </literallayout>
+            </para>
+        </answer>
+    </qandaentry>
+
+
+
+
 </qandaset>
 </appendix>
 <!-- 
Signature · 1 line
1.7.1
#12 lore raw

PATCH 12/15 documentation/poky-ref-manual/usingpoky.xml: Small edits

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

I made some minor edits.

---
 documentation/poky-ref-manual/usingpoky.xml |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
documentation/poky-ref-manual/usingpoky.xml +4 -4
index 70ed309..92e3ed5 100644
@@ -188,12 +188,12 @@
     <para>
         The exact method for debugging Poky depends on the nature of the 
         problem and on the system's area from which the bug originates. 
-        Standard debugging practises such as comparison against the last 
-        known working version with examination of the changes and the reapplication of steps 
+        Standard debugging practices such as comparison against the last 
+        known working version with examination of the changes and the re-application of steps 
         to identify the one causing the problem are
         valid for Poky just as they are for any other system. 
-        It's impossible to detail every possible potential failure but here are some general
-        tips to aid in debugging:
+        Even though it is impossible to detail every possible potential failure, 
+        here are some general tips to aid in debugging:
     </para>
 
     <section id='usingpoky-debugging-taskfailures'>
Signature · 1 line
1.7.1
#13 lore raw

PATCH 13/15 documentation/poky-ref-manual/extendpoky.xml: small edits

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

Various small edits and format changes.

---
 documentation/poky-ref-manual/extendpoky.xml |   29 +++++++++++++------------
 1 files changed, 15 insertions(+), 14 deletions(-)
documentation/poky-ref-manual/extendpoky.xml +15 -14
index 951468d..8e41031 100644
@@ -81,7 +81,7 @@ do_install() {
                 Applications that use autotools such as <filename>autoconf</filename> and 
                 <filename>automake</filename> require a recipe that has a source archive listed in 
                 <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm> and 
-                <filename>also inherits autotools</filename>, which instructs BitBake to use the
+                also inherits autotools, which instructs BitBake to use the
                 <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps
                 needed to build an autotooled application.
                 The result of the build is automatically packaged. 
@@ -114,7 +114,7 @@ inherit autotools gettext
             <para>
                 Applications that use GNU <filename>make</filename> also require a recipe that has
                 the source archive listed in <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm>. 
-                You do not need to add a <function>do_compile</function> step since by default BitBake 
+                You do not need to add a "do_compile" step since by default BitBake 
                 starts the <filename>make</filename> command to compile the application. 
                 If you need additional <filename>make</filename> options you should store them in the 
                 <glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm> variable.
@@ -209,8 +209,8 @@ FILES_sxpm = "${bindir}/sxpm"
             <title>Post Install Scripts</title>
 
             <para>
-                To add a post-installation script to a package, add a <function>pkg_postinst_PACKAGENAME()
-                </function> function to the <filename>.bb</filename> file and use 
+                To add a post-installation script to a package, add a <filename>pkg_postinst_PACKAGENAME()
+                </filename> function to the <filename>.bb</filename> file and use 
                 <filename>PACKAGENAME</filename> as the name of the package you want to attach to the 
                 <filename>postinst</filename> script.
                 Normally <glossterm><link linkend='var-PN'>PN</link></glossterm> can be used, which 
@@ -298,8 +298,8 @@ IMAGE_INSTALL += "strace"
             <para>
                 For complex custom images, the best approach is to create a custom task package
                 that is used to build the image or images. 
-                A good example of a tasks package is <filename>meta/recipes-sato/tasks/task-poky.bb
-                </filename>. 
+                A good example of a tasks package is 
+                <filename>meta/recipes-sato/tasks/task-poky.bb</filename>. 
                 The <glossterm><link linkend='var-PACKAGES'>PACKAGES</link></glossterm> 
                 variable lists the task packages to build along with the complementary
                 -dbg and -dev packages. 
@@ -494,7 +494,7 @@ COMPATIBLE_MACHINE = '(qemux86|qemumips)'
             <title>Adding a Formfactor Configuration File</title>
             <para>
                 A formfactor configuration file provides information about the 
-                target hardware on which Poky is running, and information that Poky cannot 
+                target hardware on which Poky is running and information that Poky cannot 
                 obtain from other sources such as the kernel.  
                 Some examples of information contained in a formfactor configuration file include 
                 framebuffer orientation, whether or not the system has a keyboard, 
@@ -505,7 +505,7 @@ COMPATIBLE_MACHINE = '(qemux86|qemumips)'
                 Reasonable defaults are used in most cases, but if customization is 
                 necessary you need to create a <filename>machconfig</filename> file 
                 under <filename>meta/packages/formfactor/files/MACHINENAME/</filename>,
-                where <literal>MACHINENAME</literal> is the name for which this information
+                where <filename>MACHINENAME</filename> is the name for which this information
                 applies. 
                 For information about the settings available and the defaults, see 
                 <filename>meta/packages/formfactor/files/config</filename>. 
@@ -674,7 +674,7 @@ BBFILE_PRIORITY_emenlow = "6"
     variables allowing moves to be made towards generating checksums and allowing
     use of the dependency information in other parts of bitbake.
     
-    Signed-off-by: Richard Purdie [email protected]
+    Signed-off-by: Richard Purdie [email protected]
             </literallayout>
 
             <para>
@@ -714,7 +714,7 @@ BBFILE_PRIORITY_emenlow = "6"
                 Usually, version increases occur only to packages.
                 However, if for some reason PV changes but does not increase, you can increase the 
                 <glossterm><link linkend='var-PE'>PE</link></glossterm> variable (Package Epoch).
-                The PE variable defaults to '0'.
+                The PE variable defaults to "0".
             </para>
             <para>
                 Version numbering strives to follow the 
@@ -823,7 +823,8 @@ BBFILE_PRIORITY_emenlow = "6"
             For a standard recipe not related to 
             <glossterm><link linkend='var-MACHINE'>MACHINE</link></glossterm> the location is
             <filename>tmp/work/PACKAGE_ARCH-poky-TARGET_OS/PN-PV-PR/</filename>.
-            For target device-dependent packages you should use the MACHINE variable instead of 
+            For target device-dependent packages you should use the <filename>MACHINE</filename>
+            variable instead of 
             <glossterm><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></glossterm> 
             in the directory name.
         </para>
@@ -864,19 +865,19 @@ BBFILE_PRIORITY_emenlow = "6"
                 into the new patch file:
 
                 <literallayout class='monospaced'>
-quilt new NAME-OF-PATCH.patch
+     quilt new NAME-OF-PATCH.patch
                 </literallayout>
 
                 After notifying quilt, add all modified files into that patch:
                 <literallayout class='monospaced'>
-quilt add file1 file2 file3
+     quilt add file1 file2 file3
                 </literallayout>
 
                 You can now start editing. 
                 Once you are done editing, you need to use quilt to generate the final patch that 
                 will contain all your modifications.
                 <literallayout class='monospaced'>
-quilt refresh
+     quilt refresh
                 </literallayout>
 
                 You can find the resulting patch file in the
Signature · 1 line
1.7.1
#14 lore raw

PATCH 14/15 documentation/poky-ref-manual/extendpoky.xml: Formfactor path corrected

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

I changed the path 'meta/packages/formfactor/files/config' to 'meta/recipes-bsp/formfactor/files/config' per Joshua Lock's instruction for correctness.

---
 documentation/poky-ref-manual/extendpoky.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/extendpoky.xml +1 -1
index 8e41031..5bf22e5 100644
@@ -508,7 +508,7 @@ COMPATIBLE_MACHINE = '(qemux86|qemumips)'
                 where <filename>MACHINENAME</filename> is the name for which this information
                 applies. 
                 For information about the settings available and the defaults, see 
-                <filename>meta/packages/formfactor/files/config</filename>. 
+                <filename>meta/recipes-bsp/formfactor/files/config</filename>. 
                 Following is an example for qemuarm:
             </para>
             <programlisting>
Signature · 1 line
1.7.1
#15 lore raw

PATCH 15/15 documentation/poky-ref-manual/faq.xml: Added entry about proxy and firewall

In reply to [email protected]

From: Scott Rifenbark <[email protected]>

This is an explanation on how to get by the proxy or around the firewall when Poky is trying to find and download sources.

---
 documentation/poky-ref-manual/faq.xml |   96 +++++++++++++++++++++++++++++++++
 1 files changed, 96 insertions(+), 0 deletions(-)
documentation/poky-ref-manual/faq.xml +96 -0
index 366db6c..f4b5ae0 100644
@@ -413,6 +413,102 @@
         </answer>
     </qandaentry>
 
+    <qandaentry>
+        <question>
+            <para>
+                How does Poky obtain source code and will it work behind my firewall or proxy server?
+            </para>
+        </question>
+        <answer>
+            <para>
+                The way Poky obtains source code is highly configurable.
+                You can setup Poky to get source code in most environmnents if 
+                HTTP transport is available.
+            </para>
+            <para>
+                When Poky searches for source code it first tries the local download directory.
+                If that location fails, Poky tries PREMIRRORS, the upstream source, 
+                and then MIRRORS in that order.
+            </para>
+            <para>
+                By default, Poky uses the Yocto Project source PREMIRRORS for SCM-based sources, 
+                upstreams for normal tarballs and then falls back to a number of other mirrors 
+                including the Yocto Project source mirror if those fail.
+            </para>
+            <para>
+                As an example, you could add a specific server for Poky to attempt before any
+                others by adding something like the following to the <filename>local.conf</filename>
+                configuration file:
+                <literallayout class='monospaced'>
+     PREMIRRORS_prepend = "\
+     git://.*/.* http://autobuilder.yoctoproject.org/sources/ \n \
+     ftp://.*/.* http://autobuilder.yoctoproject.org/sources/ \n \
+     http://.*/.* http://autobuilder.yoctoproject.org/sources/ \n \
+     https://.*/.* http://autobuilder.yoctoproject.org/sources/ \n"
+                </literallayout>
+            </para>
+            <para>
+                These changes cause Poky to intercept GIT, FTP, HTTP, and HTTPS
+                requests and direct them to the <filename>http://</filename> sources mirror.
+                You can use <filename>file://</filename> urls to point to local directories 
+                or network shares as well.
+            </para>
+            <para>
+                Aside from the previous technique, these options also exist:
+                <literallayout class='monospaced'>
+     BB_NO_NETWORK = "1"
+                </literallayout>
+             </para>
+             <para>
+                 This statement tells BitBake to throw an error instead of trying to access the 
+                 Internet.
+                 This technique is useful if you want to ensure code builds only from local sources.
+             </para>
+             <para>
+                 Here is another technique:
+                 <literallayout class='monospaced'>
+     BB_FETCH_PREMIRRORONLY = "1"
+                 </literallayout>
+             </para>
+             <para>
+                 This statement limits Poky to pulling source from the PREMIRRORS only.
+                 Again, this technique is useful for reproducing builds.
+             </para>
+             <para>
+                 Here is another technique:
+                 <literallayout class='monospaced'>
+     BB_GENERATE_MIRROR_TARBALLS = "1"
+                 </literallayout>
+             </para>
+             <para>
+                 This statement tells Poky to generate mirror tarballs.
+                 This technique is useful if you want to create a mirror server.
+                 If not, however, the technique can simply waste time during the build.
+             </para>
+             <para>
+                 Finally, consider an example where you are behind an HTTP-only firewall.
+                 You could make the following changes to the <filename>local.conf</filename>
+                 configuration file as long as the premirror server is up to date:
+                 <literallayout class='monospaced'>
+     PREMIRRORS_prepend = "\
+     ftp://.*/.* http://autobuilder.yoctoproject.org/sources/ \n \
+     http://.*/.* http://autobuilder.yoctoproject.org/sources/ \n \
+     https://.*/.* http://autobuilder.yoctoproject.org/sources/ \n"
+     BB_FETCH_PREMIRRORONLY = "1" 
+                 </literallayout>
+             </para>
+             <para>
+                 These changes would cause Poky to successfully fetch source over HTTP and 
+                 any network accesses to anything other than the premirror would fail.
+             </para>
+             <para>
+                 Poky also honors the standard environment variables 
+                 <filename>http_proxy</filename>, <filename>ftp_proxy</filename>, 
+                 <filename>https_proxy</filename>, and <filename>all_proxy</filename>
+                 to redirect requests through proxy servers.
+             </para>
+        </answer>
+    </qandaentry>
 
 
 
Signature · 1 line
1.7.1
#16 lore raw
In reply to [email protected]
Quoted 30 lines · On Fri, 2011-03-18 at 10:59 -0600, [email protected] wrote:

From: Scott Rifenbark <[email protected]>

These commits are the changes for the Poky Reference Manual. Some bugs taken care of, spell-checks, title page updates, grammar fixes, FAQ entries, formfactor path fix.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/poky-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/poky-work

Thanks,
<[email protected]>
---

Scott Rifenbark (15):
[BUGID# 873] - documentation/poky-ref-manual: Notes added for
non-GPLv3 builds
[BUGID# 293] - documentation/poky-ref-manual/extendpoky.xml: Added
text for choosing server
documentation/poky-ref-manual/extendpoky.xml: Spell check documentation/poky-ref-manual/style.css: Updated to match other
manuals
documentation/poky-ref-manual/poky-ref-manual.xml: Updated title page documentation/poky-ref-manual/faq.xml: Spell Check documentation/poky-ref-manual/introduction.xml: Removed link documentation/poky-ref-manual/introduction.xml: Wording and release
update
documentation/poky-ref-manual/usingpoky.xml: grammar fix and BitBake
fix

Quoted 8 lines

documentation/poky-ref-manual/usingpoky.xml: More BitBake changes documentation/poky-ref-manual/faq.xml: Added three FAQ entries documentation/poky-ref-manual/usingpoky.xml: Small edits documentation/poky-ref-manual/extendpoky.xml: small edits documentation/poky-ref-manual/extendpoky.xml: Formfactor path
corrected
documentation/poky-ref-manual/faq.xml: Added entry about proxy and
firewall

Merged to master, thanks Scott.

Cheers,

Richard