Misc documentation updates
cover Misc documentation updates
The following changes since commit a85840611650c9124b6194acca59c8bfe71f566c:
documentation: dev-manual - trademark added and reference updated. (2012-10-01 09:27:42 -0700)
are available in the git repository at:
git://git.yoctoproject.org/poky-contrib paule/doc-fixes-4
http://git.yoctoproject.org/cgit.cgi/poky-contrib/log/?h=paule/doc-fixes-4
Paul Eggleton (11):
documentation/poky-ref-manual: the G in GPL is "General" documentation/poky-ref-manual: add staticdev-pkgs documentation/poky-ref-manual: add SDKIMAGE_FEATURES documentation/poky-ref-manual: minor improvements documentation/poky-ref-manual: remove reference to Ubuntu Intrepid
documentation: update for current netbase version documentation/dev-manual: clarify section on updating PR documentation/poky-ref-manual: update FAQ for adding a new board documentation/poky-ref-manual: update FAQ on stability documentation/poky-ref-manual: clarify FAQ on products using the
system
documentation/poky-ref-manual: update FAQ for Poky
documentation/bsp-guide/bsp.xml | 2 +- .../dev-manual/dev-manual-common-tasks.xml | 7 +- documentation/dev-manual/dev-manual-newbie.xml | 2 +- documentation/poky-ref-manual/faq.xml | 74 +++++++------------- documentation/poky-ref-manual/ref-features.xml | 2 + documentation/poky-ref-manual/ref-images.xml | 4 +- documentation/poky-ref-manual/ref-variables.xml | 27 ++++--- documentation/poky-ref-manual/usingpoky.xml | 6 +- 8 files changed, 57 insertions(+), 67 deletions(-)
Signature · 1 line
1.7.9.5
PATCH 1/11 documentation/poky-ref-manual: the G in GPL is "General"
--- documentation/poky-ref-manual/ref-images.xml | 4 ++-- documentation/poky-ref-manual/usingpoky.xml | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-)
documentation/poky-ref-manual/ref-images.xml +2 -2
@@ -12,8 +12,8 @@ </para> <note> - Building an image without GNU Public License Version 3 (GPLv3) components is - only supported for minimal and base images. + Building an image without GNU General 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:
documentation/poky-ref-manual/usingpoky.xml +3 -3
@@ -66,8 +66,8 @@ </para> <note> - Building an image without GNU Public License Version 3 (GPLv3) components is - only supported for minimal and base images. + Building an image without GNU General Public License Version 3 (GPLv3) components + is only supported for minimal and base images. See the "<link linkend='ref-images'>Images</link>" chapter for more information. </note> </section>
@@ -78,7 +78,7 @@ <para> When building an image using GPL components, you need to maintain your original settings and not switch back and forth applying different versions of the GNU - Public License. + General Public License. If you rebuild using different versions of GPL, dependency errors might occur due to some components not being rebuilt. </para>
Signature · 1 line
1.7.9.5
PATCH 2/11 documentation/poky-ref-manual: add staticdev-pkgs
In reply to Paul EggletonDocument the new staticdev-pkgs IMAGE_FEATURES item.
--- documentation/poky-ref-manual/ref-features.xml | 2 ++ 1 file changed, 2 insertions(+)
documentation/poky-ref-manual/ref-features.xml +2 -0
@@ -161,6 +161,8 @@ <listitem><para><emphasis>nfs-server:</emphasis> Installs an NFS server.</para></listitem> <listitem><para><emphasis>dev-pkgs:</emphasis> Installs development packages (headers and extra library links) for all packages installed in a given image.</para></listitem> + <listitem><para><emphasis>staticdev-pkgs:</emphasis> Installs static development packages (static + libraries i.e .a files) for all packages installed in a given image.</para></listitem> <listitem><para><emphasis>dbg-pkgs:</emphasis> Installs debug symbol packages for all packages installed in a given image.</para></listitem> <listitem><para><emphasis>doc-pkgs:</emphasis> Installs documentation packages for all packages
Signature · 1 line
1.7.9.5
PATCH 3/11 documentation/poky-ref-manual: add SDKIMAGE_FEATURES
In reply to Paul EggletonAdd new SDKIMAGE_FEATURES to variable reference.
--- documentation/poky-ref-manual/ref-variables.xml | 10 ++++++++++ 1 file changed, 10 insertions(+)
documentation/poky-ref-manual/ref-variables.xml +10 -0
@@ -1868,6 +1868,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> + <glossdef> + <para>Equivalent to + <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> + except it applies to the SDK generated from an image (using + <filename>bitbake -c populate_sdk imagename</filename>). + </para> + </glossdef> + </glossentry> + <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> <glossdef> <para>The section where package should be put.
Signature · 1 line
1.7.9.5
PATCH 4/11 documentation/poky-ref-manual: minor improvements
In reply to Paul EggletonAdjust a few sentences so that they make sense.
--- documentation/poky-ref-manual/ref-variables.xml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-)
documentation/poky-ref-manual/ref-variables.xml +9 -8
@@ -797,12 +797,13 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> <glossdef> - <para>The list of features present in images. - Typically, you configure this variable in image recipes. - Note that you can add extra features to the image by using the + <para>The list of features to include in an images. + Typically, you configure this variable in an image recipe. + Note that you can also add extra features to the image by using the <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. See the "<link linkend="ref-features-image">Images</link>" section for the - list of features present in images built by the OpenEmbedded build system.</para> + full list of features which can be included in images built by the + OpenEmbedded build system.</para> </glossdef> </glossentry>
@@ -1880,8 +1881,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> <glossdef> - <para>The section where package should be put. - Package managers use this variable.</para> + <para>The section in which packages should be categorised. + Package management utilities may make use of this variable.</para> </glossdef> </glossentry>
@@ -1918,7 +1919,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdef> <para> Specifies the endian byte order of the target system. - The variable is either "le" for little-endian or "be" for big-endian. + The value should be either "le" for little-endian or "be" for big-endian. </para> </glossdef> </glossentry>
@@ -1927,7 +1928,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdef> <para> Specifies the number of bits for the target system CPU. - The variable is either "32" or "64". + The value should be either "32" or "64". </para> </glossdef> </glossentry>
Signature · 1 line
1.7.9.5
PATCH 5/11 documentation/poky-ref-manual: remove reference to Ubuntu Intrepid
In reply to Paul EggletonWe haven't supported Ubuntu Intrepid (8.04) for some time now.
--- documentation/poky-ref-manual/faq.xml | 22 ---------------------- 1 file changed, 22 deletions(-)
documentation/poky-ref-manual/faq.xml +0 -22
@@ -310,28 +310,6 @@ <qandaentry> <question> <para> - I'm using Ubuntu Intrepid and am seeing build failures. What’s wrong? - </para> - </question> - <answer> - <para> - In Intrepid, Ubuntu turns on by default the normally optional compile-time security features - and warnings. - There are more details at - <ulink url='https://wiki.ubuntu.com/CompilerFlags'>https://wiki.ubuntu.com/CompilerFlags</ulink>. - You can work around this problem by disabling those options by adding - the following to the <filename>BUILD_CPPFLAGS</filename> variable in the - <filename>conf/bitbake.conf</filename> file. - <literallayout class='monospaced'> - " -Wno-format-security -U_FORTIFY_SOURCE" - </literallayout> - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> What’s the difference between <filename>foo</filename> and <filename>foo-native</filename>? </para> </question>
Signature · 1 line
1.7.9.5
PATCH 6/11 documentation: update for current netbase version
In reply to Paul EggletonUpdate references to the netbase recipe to the current version (5.0).
--- documentation/bsp-guide/bsp.xml | 2 +- documentation/poky-ref-manual/faq.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
documentation/bsp-guide/bsp.xml +1 -1
@@ -871,7 +871,7 @@ <para> To better understand this, consider an example that customizes a recipe by adding a BSP-specific configuration file named <filename>interfaces</filename> to the - <filename>netbase_4.47.bb</filename> recipe for machine "xyz". + <filename>netbase_5.0.bb</filename> recipe for machine "xyz". Do the following: <orderedlist> <listitem><para>Edit the <filename>netbase_4.47.bbappend</filename> file so that it
documentation/poky-ref-manual/faq.xml +1 -1
@@ -399,7 +399,7 @@ 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 + meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend </literallayout> </para> </answer>
Signature · 1 line
1.7.9.5
PATCH 7/11 documentation/dev-manual: clarify section on updating PR
In reply to Paul EggletonSetting PR = "r0" isn't mandatory, but is recommended. Also, there isn't really any restriction on its format.
--- .../dev-manual/dev-manual-common-tasks.xml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
documentation/dev-manual/dev-manual-common-tasks.xml +3 -4
@@ -1538,11 +1538,10 @@ <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> variable needs to be increased (or "bumped") as part of that commit. - This means that for new recipes you must be sure to add the <filename>PR</filename> + For new recipes you should add the <filename>PR</filename> variable and set its initial value equal to "r0". - Failing to define <filename>PR</filename> makes it easy to miss when you bump a package. - Note that you can only use integer values following the "r" in the - <filename>PR</filename> variable. + This is the default value, however, adding it initially makes + it harder to miss bumping it when you make changes in future. </para> <para>
Signature · 1 line
1.7.9.5
PATCH 8/11 documentation/poky-ref-manual: update FAQ for adding a new board
In reply to Paul EggletonSince we are using a layer-based approach, people do not need to rely upon us to add support for new boards.
--- documentation/poky-ref-manual/faq.xml | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)
documentation/poky-ref-manual/faq.xml +5 -7
@@ -91,13 +91,11 @@ </question> <answer> <para> - There are two main ways to get a board supported in the Yocto Project; - <itemizedlist> - <listitem><para>Send the Yocto Project team information on the board - and if the team does not have it yet they will consider adding it.</para></listitem> - <listitem><para>Send the Yocto Project team the BitBake recipes if you have them. - </para></listitem> - </itemizedlist> + Support for an additional board is added by creating a BSP layer for it. + For more information on how to create a BSP layer, please see the + <ulink url='&YOCTO_DOCS_BSP_URL;'>BSP Guide</ulink>. + </para> + <para> Usually, if the board is not completely exotic, adding support in the Yocto Project is fairly straightforward. </para>
Signature · 1 line
1.7.9.5
PATCH 9/11 documentation/poky-ref-manual: update FAQ on stability
In reply to Paul Eggleton* Explain that we test with a set of reference hardware rather than only supporting hardware that we have (avoiding any implication that the build system can't support other devices).
* Adjust the language so that it is OE-Core friendly, with a link to the Development Manual for the definition of OE-Core.
--- documentation/dev-manual/dev-manual-newbie.xml | 2 +- documentation/poky-ref-manual/faq.xml | 14 ++++++++------ 2 files changed, 9 insertions(+), 7 deletions(-)
documentation/dev-manual/dev-manual-newbie.xml +1 -1
@@ -304,7 +304,7 @@ <listitem><para id='metadata'><emphasis>Metadata:</emphasis> The files that BitBake parses when building an image. Metadata includes recipes, classes, and configuration files.</para></listitem> - <listitem><para><emphasis>OE-Core:</emphasis> A core set of metadata originating + <listitem><para id='oe-core'><emphasis>OE-Core:</emphasis> A core set of metadata originating with OpenEmbedded (OE) that is shared between OE and the Yocto Project. This metadata is found in the <filename>meta</filename> directory of the source directory.</para></listitem>
documentation/poky-ref-manual/faq.xml +8 -6
@@ -63,7 +63,7 @@ <qandaentry> <question> <para> - How can you claim Poky is stable? + How can you claim Poky / OpenEmbedded-Core is stable? </para> </question> <answer>
@@ -71,11 +71,13 @@ There are three areas that help with stability; <itemizedlist> <listitem><para>The Yocto Project team keeps - <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> small and focused. - It contains around 650 packages as compared to over 5000 for full - OpenEmbedded.</para></listitem> - <listitem><para>The Yocto Project only supports hardware that the - team has access to for testing.</para></listitem> + <ulink url='&YOCTO_DOCS_DEV_URL;#oe-core'>OE-Core</ulink> small + and focused, containing around 830 recipes as opposed to the thousands + available in other OpenEmbedded community layers; this makes it easy to + test and maintain.</para></listitem> + <listitem><para>The Yocto Project team runs manual and automated tests + using a small, fixed set of reference hardware as well as emulated + targets.</para></listitem> <listitem><para>The Yocto Project uses an an autobuilder, which provides continuous build and integration tests.</para></listitem> </itemizedlist>
Signature · 1 line
1.7.9.5
PATCH 10/11 documentation/poky-ref-manual: clarify FAQ on products using the system
In reply to Paul EggletonAdjust language slightly so that it reads correctly, and avoid conflating the terms OpenEmbedded and Poky.
--- documentation/poky-ref-manual/faq.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
documentation/poky-ref-manual/faq.xml +4 -4
@@ -107,15 +107,15 @@ <qandaentry> <question> <para> - Are there any products using the OpenEmbedded build system (poky)? + Are there any products built using the OpenEmbedded build system? </para> </question> <answer> <para> - The <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink> is using - the OpenEmbedded build system. + The software running on the <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink> + is built using the OpenEmbedded build system. See the <ulink url='http://www.vernier.com/products/interfaces/labq/'>Vernier LabQuest</ulink> - for more information. + website for more information. There are a number of pre-production devices using the OpenEmbedded build system and the Yocto Project team announces them as soon as they are released.
Signature · 1 line
1.7.9.5
PATCH 11/11 documentation/poky-ref-manual: update FAQ for Poky
In reply to Paul EggletonEnsure that this section correctly and accurately describes how Poky and OE relate to eachother currently.
--- documentation/poky-ref-manual/faq.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
documentation/poky-ref-manual/faq.xml +8 -8
@@ -13,14 +13,14 @@ </question> <answer> <para> - The term "Poky" is sometimes used to refer to the build system that the - Yocto Project uses. - The build system used in the Yocto project is referred to as the - OpenEmbedded build system because "Poky" was derived from <ulink - url='&OE_HOME_URL;'>OpenEmbedded</ulink>. - Poky is a stable, smaller subset focused on the mobile environment. - Development in the Yocto Project using Poky is closely tied to OpenEmbedded with - features being merged regularly between the two for mutual benefit. + The term "Poky" refers to the specific reference build system that + the Yocto Project provides; Poky is based upon + <ulink url='&YOCTO_DOCS_DEV_URL;#oe-core'>OE-Core</ulink> + and BitBake and thus the generic term used here for the build system is + the OpenEmbedded build system. + Development in the Yocto Project using Poky is closely tied to OpenEmbedded, with + changes always being merged to OE-Core or BitBake first before being pulled back + into Poky, benefiting both projects immediately. For a fuller description of the term "Poky", see the <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>poky</ulink> term in the Yocto Project Development Manual.
Signature · 1 line
1.7.9.5