* [yocto-docs][PATCH 01/12] documentation/bsp-guide, dev-manual-bsp-appendix: remove references to task bbappend
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
@ 2012-09-05 14:34 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 02/12] documentation/poky-ref-manual: fix for rename of task to packagegroup Paul Eggleton
` (10 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:34 UTC (permalink / raw)
To: yocto
The meta-intel BSPs and yocto-bsp tool no longer use a bbappend of
task-core-tools-profile to add systemtap, so these sections should be
removed.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/bsp-guide/bsp.xml | 24 ----------------
.../dev-manual/dev-manual-bsp-appendix.xml | 29 --------------------
2 files changed, 53 deletions(-)
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 0c7ead5..5bfa9fb 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -172,9 +172,6 @@
meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay-noemgd/
meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay-noemgd/machconfig
- meta-crownbay/recipes-core/
- meta-crownbay/recipes-core/tasks/
- meta-crownbay/recipes-core/tasks/task-core-tools-profile.bbappend
meta-crownbay/recipes-graphics/
meta-crownbay/recipes-graphics/xorg-xserver/
meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend
@@ -447,27 +444,6 @@
</para></note>
</section>
- <section id='bsp-filelayout-core-recipes'>
- <title>Core Recipe Files</title>
- <para>
- You can find these files in the BSP Layer at:
- <literallayout class='monospaced'>
- meta-<bsp_name>/recipes-core/*
- </literallayout>
- </para>
-
- <para>
- This directory contains recipe files that are almost always necessary to build a
- useful, working Linux image.
- Thus, the term "core" is used to group these recipes.
- For example, in the Crown Bay BSP there is the
- <filename>task-core-tools-profile.bbappend</filename> file, which is an append file used
- to recommend that the
- <ulink url='http://sourceware.org/systemtap/wiki'>SystemTap</ulink>
- package be included as a package when the image is built.
- </para>
- </section>
-
<section id='bsp-filelayout-recipes-graphics'>
<title>Display Support Files</title>
<para>
diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml
index 98ed837..50a0049 100644
--- a/documentation/dev-manual/dev-manual-bsp-appendix.xml
+++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml
@@ -358,35 +358,6 @@
</para>
</section>
- <section id='changing-recipes-core'>
- <title>Changing <filename>recipes-core</filename></title>
-
- <para>
- Now let's look at changes in <filename>recipes-core</filename>.
- The file <filename>task-core-tools.bbappend</filename> in
- <filename>recipes-core/tasks</filename> appends the similarly named recipe
- located in the <link linkend='source-directory'>source directory</link> at
- <filename>meta/recipes-core/tasks</filename>.
- The append file in our layer right now is Crown Bay-specific and supports
- EMGD and non-EMGD.
- Here are the contents of the file:
- <literallayout class='monospaced'>
- RRECOMMENDS_task-core-tools-profile_append_crownbay = " systemtap"
- RRECOMMENDS_task-core-tools-profile_append_crownbay-noemgd = " systemtap"
- </literallayout>
- </para>
-
- <para>
- The <filename>RRECOMMENDS</filename> statements list packages that
- extend usability.
- The first <filename>RRECOMMENDS</filename> statement can be removed, while the
- second one can be changed to reflect <filename>meta-mymachine</filename>:
- <literallayout class='monospaced'>
- RRECOMMENDS_task-core-tools-profile_append_mymachine = " systemtap"
- </literallayout>
- </para>
- </section>
-
<section id='changing-recipes-kernel'>
<title>Changing <filename>recipes-kernel</filename></title>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 02/12] documentation/poky-ref-manual: fix for rename of task to packagegroup
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
2012-09-05 14:34 ` [yocto-docs][PATCH 01/12] documentation/bsp-guide, dev-manual-bsp-appendix: remove references to task bbappend Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 03/12] documentation/dev-manual: fix for package group changes Paul Eggleton
` (9 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 2 +-
documentation/poky-ref-manual/ref-variables.xml | 8 ++++----
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 330d72e..ff8db59 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -124,7 +124,7 @@
Once a provider is selected, BitBake resolves all the dependencies for
the target.
In the case of <filename>core-image-sato</filename>, it would lead to
- <filename>task-base.bb</filename>,
+ <filename>packagegroup-base.bb</filename>,
which in turn leads to packages like <filename>Contacts</filename>,
<filename>Dates</filename> and <filename>BusyBox</filename>.
These packages in turn depend on <filename>eglibc</filename> and the toolchain.
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 362ece4..b1e3cd3 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -1311,7 +1311,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
The build process depends on these packages being present.
Furthermore, because this is a "machine essential" variable, the list of
packages are essential for the machine to boot.
- The impact of this variable affects images based on <filename>task-core-boot</filename>,
+ The impact of this variable affects images based on <filename>packagegroup-core-boot</filename>,
including the <filename>core-image-minimal</filename> image.
</para>
<para>
@@ -1341,7 +1341,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
The build process does not depend on these packages being present.
Furthermore, because this is a "machine essential" variable, the list of
packages are essential for the machine to boot.
- The impact of this variable affects images based on <filename>task-core-boot</filename>,
+ The impact of this variable affects images based on <filename>packagegroup-core-boot</filename>,
including the <filename>core-image-minimal</filename> image.
</para>
<para>
@@ -1388,7 +1388,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
Even though these packages are not essential for the machine to boot,
the build process depends on them being present.
The impact of this variable affects all images based on
- <filename>task-base</filename>, which does not include the
+ <filename>packagegroup-base</filename>, which does not include the
<filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
images.
</para>
@@ -1425,7 +1425,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
The package being built has no build dependency on the list of packages
with this variable.
The impact of this variable affects only images based on
- <filename>task-base</filename>, which does not include the
+ <filename>packagegroup-base</filename>, which does not include the
<filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
images.
</para>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 03/12] documentation/dev-manual: fix for package group changes
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
2012-09-05 14:34 ` [yocto-docs][PATCH 01/12] documentation/bsp-guide, dev-manual-bsp-appendix: remove references to task bbappend Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 02/12] documentation/poky-ref-manual: fix for rename of task to packagegroup Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 04/12] documentation/poky-ref-manual: improve IMAGE_FEATURES reference Paul Eggleton
` (8 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
Task has been renamed to package group, and there are some minor changes
in how package group recipes should be constructed - in particular the
inherit of packagegroup.bbclass is now highly recommended as it will set
appropriate defaults and automatically add complementary -dev and -dbg
packages.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
.../dev-manual/dev-manual-common-tasks.xml | 48 ++++++++++----------
1 file changed, 24 insertions(+), 24 deletions(-)
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index bdf59de..5e9f5e7 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -465,7 +465,7 @@
One way to get additional software into an image is to create a custom image.
The following example shows the form for the two lines you need:
<literallayout class='monospaced'>
- IMAGE_INSTALL = "task-core-x11-base package1 package2"
+ IMAGE_INSTALL = "packagegroup-core-x11-base package1 package2"
inherit core-image
</literallayout>
@@ -494,58 +494,58 @@
</section>
<section id='usingpoky-extend-customimage-customtasks'>
- <title>Customizing Images Using Custom Tasks</title>
+ <title>Customizing Images Using Custom Package Groups</title>
<para>
- For complex custom images, the best approach is to create a custom task package
+ For complex custom images, the best approach is to create a custom package group recipe
that is used to build the image or images.
- A good example of a tasks package is
- <filename>meta/recipes-core/tasks/task-core-boot.bb</filename>
+ A good example of a package group recipe is
+ <filename>meta/recipes-core/packagegroups/packagegroup-core-boot.bb</filename>.
The
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename>
- variable lists the task packages to build along with the complementary
- <filename>-dbg</filename> and <filename>-dev</filename> packages.
- For each package added, you can use
+ variable lists the package group packages you wish to produce. <filename>inherit packagegroup</filename>
+ sets appropriate default values and automatically adds -dev and -dbg complementary
+ packages for every package specified in <filename>PACKAGES</filename>. Note that the inherit line should be towards
+ the top of the recipe, certainly before you set <filename>PACKAGES</filename>.
+ For each package you specify in <filename>PACKAGES</filename>, you can use
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename>
and
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename>
entries to provide a list of packages the parent task package should contain.
Following is an example:
<literallayout class='monospaced'>
- DESCRIPTION = "My Custom Tasks"
+ DESCRIPTION = "My Custom Package Groups"
+
+ inherit packagegroup
PACKAGES = "\
- task-custom-apps \
- task-custom-apps-dbg \
- task-custom-apps-dev \
- task-custom-tools \
- task-custom-tools-dbg \
- task-custom-tools-dev \
+ packagegroup-custom-apps \
+ packagegroup-custom-tools \
"
- RDEPENDS_task-custom-apps = "\
+ RDEPENDS_packagegroup-custom-apps = "\
dropbear \
portmap \
psplash"
- RDEPENDS_task-custom-tools = "\
+ RDEPENDS_packagegroup-custom-tools = "\
oprofile \
oprofileui-server \
lttng-control \
lttng-viewer"
- RRECOMMENDS_task-custom-tools = "\
+ RRECOMMENDS_packagegroup-custom-tools = "\
kernel-module-oprofile"
</literallayout>
</para>
<para>
- In the previous example, two task packages are created with their dependencies and their
- recommended package dependencies listed: <filename>task-custom-apps</filename>, and
- <filename>task-custom-tools</filename>.
- To build an image using these task packages, you need to add
- <filename>task-custom-apps</filename> and/or
- <filename>task-custom-tools</filename> to
+ In the previous example, two package group packages are created with their dependencies and their
+ recommended package dependencies listed: <filename>packagegroup-custom-apps</filename>, and
+ <filename>packagegroup-custom-tools</filename>.
+ To build an image using these packagegroup packages, you need to add
+ <filename>packagegroup-custom-apps</filename> and/or
+ <filename>packagegroup-custom-tools</filename> to
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>.
For other forms of image dependencies see the other areas of this section.
</para>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 04/12] documentation/poky-ref-manual: improve IMAGE_FEATURES reference
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (2 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 03/12] documentation/dev-manual: fix for package group changes Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 05/12] documentation/poky-ref-manual: replace reference to old files Paul Eggleton
` (7 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
* apps-console-core has been effectively replaced by splash
* apps-x11-core, apps-x11-games have been removed
* ssh-server-* were added quite a while ago, add these here
* x11 has been added
* x11-base has changed behaviour slightly
* doc-pkgs was added
* nfs-server never exported the entire /, so remove this comment
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-features.xml | 28 +++++++++++++++---------
1 file changed, 18 insertions(+), 10 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml
index 51bd73a..50acb4a 100644
--- a/documentation/poky-ref-manual/ref-features.xml
+++ b/documentation/poky-ref-manual/ref-features.xml
@@ -128,14 +128,21 @@
Current list of
<filename>IMAGE_FEATURES</filename> contains the following:
<itemizedlist>
- <listitem><para><emphasis>apps-console-core:</emphasis> Core console applications such as
- <filename>ssh</filename>, <filename>daemon</filename>, <filename>avahi daemon</filename>,
- <filename>portmap</filename> (for mounting NFS shares)</para></listitem>
- <listitem><para><emphasis>x11-base:</emphasis> X11 server + minimal desktop</para></listitem>
+ <listitem><para><emphasis>splash:</emphasis> enable showing a splash screen during boot. By
+ default, this is provided by <filename>psplash</filename>, which does allow customisation. If you prefer to
+ use an alternative splash screen package you can do so by setting the <filename>SPLASH</filename> variable
+ to a different package name (or names) within the image recipe or at the distro
+ configuration level.
+ </para></listitem>
+ <listitem><para><emphasis>ssh-server-dropbear:</emphasis> install the Dropbear minimal SSH server.
+ </para></listitem>
+ <listitem><para><emphasis>ssh-server-openssh:</emphasis> install the OpenSSH SSH server,
+ which is more full-featured than Dropbear. Note that if both this and ssh-server-dropbear
+ are present in <filename>IMAGE_FEATURES</filename>, then OpenSSH will take
+ precedence and Dropbear will not be installed.</para></listitem>
+ <listitem><para><emphasis>x11:</emphasis> X server</para></listitem>
+ <listitem><para><emphasis>x11-base:</emphasis> X server with minimal environment</para></listitem>
<listitem><para><emphasis>x11-sato:</emphasis> OpenedHand Sato environment</para></listitem>
- <listitem><para><emphasis>apps-x11-core:</emphasis> Core X11 applications such as an
- X Terminal, file manager, and file editor</para></listitem>
- <listitem><para><emphasis>apps-x11-games:</emphasis> A set of X11 games</para></listitem>
<listitem><para><emphasis>tools-sdk:</emphasis> A full SDK that runs on the device
</para></listitem>
<listitem><para><emphasis>tools-debug:</emphasis> Debugging tools such as
@@ -146,11 +153,12 @@
<filename>LTTng</filename></para></listitem>
<listitem><para><emphasis>tools-testapps:</emphasis> Device testing tools (e.g.
touchscreen debugging)</para></listitem>
- <listitem><para><emphasis>nfs-server:</emphasis> NFS server (exports / over NFS
- to everybody)</para></listitem>
+ <listitem><para><emphasis>nfs-server:</emphasis> NFS server</para></listitem>
<listitem><para><emphasis>dev-pkgs:</emphasis> Development packages (headers and
extra library links) for all packages installed in a given image</para></listitem>
- <listitem><para><emphasis>dbg-pkgs:</emphasis> Debug packages for all packages
+ <listitem><para><emphasis>dbg-pkgs:</emphasis> Debug symbol packages for all packages
+ installed in a given image</para></listitem>
+ <listitem><para><emphasis>doc-pkgs:</emphasis> Documentation packages for all packages
installed in a given image</para></listitem>
</itemizedlist>
</para>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 05/12] documentation/poky-ref-manual: replace reference to old files
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (3 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 04/12] documentation/poky-ref-manual: improve IMAGE_FEATURES reference Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 06/12] documentation/poky-ref-manual: update the default value of PACKAGES Paul Eggleton
` (6 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
These file paths are no longer valid, instead point to the section
of the reference manual with more information on valid IMAGE_FEATURES.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index b1e3cd3..bf1cce1 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -561,12 +561,11 @@
For example, ssh root access has a blank
password. You should remove this feature
before you produce a production image.
-
- There are other application targets too, see
- <filename>meta/classes/poky-image.bbclass</filename>
- and <filename>meta/packages/tasks/task-poky.bb</filename>
- for more details.
</literallayout>
+
+ <para>There are other valid features too, see
+ <link linkend='ref-features-image'>Image feature reference</link>
+ section for more details.</para>
</glossdef>
</glossentry>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 06/12] documentation/poky-ref-manual: update the default value of PACKAGES
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (4 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 05/12] documentation/poky-ref-manual: replace reference to old files Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 07/12] documentation/poky-ref-manual: variable reference clarifications and fixes Paul Eggleton
` (5 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
Also add a definition for PACKAGE_BEFORE_PN since the default value of
PACKAGES now includes this.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index bf1cce1..531ee8a 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -1482,6 +1482,13 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
</glossdef>
</glossentry>
+ <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm>
+ <glossdef>
+ <para>Enables easily adding packages to <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
+ before ${PN} so that they pick up files that would normally be included in the default package.</para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm>
<glossdef>
<para>This variable, which is set in the <filename>local.conf</filename> configuration
@@ -1512,7 +1519,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
<glossdef>
<para>The list of packages to be created from the recipe.
- The default value is "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev".</para>
+ The default value is "${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}".</para>
</glossdef>
</glossentry>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 07/12] documentation/poky-ref-manual: variable reference clarifications and fixes
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (5 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 06/12] documentation/poky-ref-manual: update the default value of PACKAGES Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 08/12] documentation/poky-ref-manual: add packagegroup.bbclass to classes Paul Eggleton
` (4 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
* For PE/PV/PR/PN these pertain to a recipe ("package" was used here
historically).
* References to variables should not be prefixed with $ in the text
* Add text about suffixing RCONFLICTS as per other package variables
* Make ALLOW_EMPTY example complete
* Clarify and add example for AUTOREV
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 49 +++++++++++++++--------
1 file changed, 32 insertions(+), 17 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 531ee8a..5165bf1 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -61,7 +61,7 @@
conjunction with a package name override.
Here is an example:
<literallayout class='monospaced'>
- ALLOW_EMPTY_${PN}
+ ALLOW_EMPTY_${PN} = "1"
</literallayout>
</para>
</glossdef>
@@ -76,9 +76,13 @@
<glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
<glossdef>
- <para>Specifies to use the current (newest) source revision.
- This variable is with the <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
- variable.</para>
+ <para>When <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
+ is set to the value of this variable, it specifies that the latest
+ source revision in the repository should be used. Here is an example:
+ <literallayout class='monospaced'>
+ SRCREV = "${AUTOREV}"
+ </literallayout>
+ </para>
</glossdef>
</glossentry>
@@ -1478,7 +1482,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
<glossdef>
- <para>The architecture of the resulting package.</para>
+ <para>The architecture of the resulting package(s).</para>
</glossdef>
</glossentry>
@@ -1536,14 +1540,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<glossentry id='var-PN'><glossterm>PN</glossterm>
<glossdef>
- <para>The name of the package.
+ <para>The name of the recipe. The name is normally extracted from the recipe file name.
+ For example, if the recipe is named
+ <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename>
+ will be "expat".
</para>
</glossdef>
</glossentry>
<glossentry id='var-PR'><glossterm>PR</glossterm>
<glossdef>
- <para>The revision of the package.
+ <para>The revision of the recipe.
The default value for this variable is "r0".
</para>
</glossdef>
@@ -1551,13 +1558,13 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<glossentry id='var-PV'><glossterm>PV</glossterm>
<glossdef>
- <para>The version of the package.
- The version is normally extracted from the recipe name.
+ <para>The version of the recipe.
+ The version is normally extracted from the recipe file name.
For example, if the recipe is named
- <filename>expat_2.0.1.bb</filename>, then <filename>PV</filename>
- will be <filename>2.0.1</filename>.
+ <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename>
+ will be "2.0.1".
<filename>PV</filename> is generally not overridden within
- a recipe unless it is building an unstable version from a source code repository
+ a recipe unless it is building an unstable/development version from a source code repository
(e.g. Git or Subversion).
</para>
</glossdef>
@@ -1566,7 +1573,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<glossentry id='var-PE'><glossterm>PE</glossterm>
<glossdef>
<para>
- the epoch of the package.
+ the epoch of the recipe.
The default value is "0".
The field is used to make upgrades possible when the versioning scheme changes in
some backwards incompatible way.
@@ -1581,7 +1588,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
determines which recipe should be given preference.
The variable must always be suffixed with the name of the
provided item, and should be set to the
- <filename>$PN</filename> of the recipe
+ <filename>PN</filename> of the recipe
to which you want to give precedence.
Here is an example:
<literallayout class='monospaced'>
@@ -1596,9 +1603,9 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<para>
If there are multiple versions of recipes available, this
variable determines which recipe should be given preference.
- The variable must always be suffixed with the <filename>$PN</filename>
+ The variable must always be suffixed with the <filename>PN</filename>
for which to select, and should be set to the
- <filename>$PV</filename> to which you want to give precedence.
+ <filename>PV</filename> to which you want to give precedence.
You can use the "<filename>%</filename>" character as a wildcard
to match any number of characters, which can be useful when
specifying versions that contain long revision number that could
@@ -1621,9 +1628,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
<glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm>
<glossdef>
- <para>The list of packages that conflict with this package.
+ <para>The list of packages that conflict with a package.
Note that the package will not be installed if the conflicting packages are not
first removed.</para>
+ <para>
+ Like all package-controlling variables, you must always use them in
+ conjunction with a package name override.
+ Here is an example:
+ <literallayout class='monospaced'>
+ RCONFLICTS_${PN} = "another-conflicting-package-name"
+ </literallayout>
+ </para>
</glossdef>
</glossentry>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 08/12] documentation/poky-ref-manual: add packagegroup.bbclass to classes
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (6 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 07/12] documentation/poky-ref-manual: variable reference clarifications and fixes Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 09/12] documentation/poky-ref-manual: update undocumented classes list Paul Eggleton
` (3 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
Add a short section about packagegroup.bbclass.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-classes.xml | 22 +++++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index c06e362..b836e2c 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -262,6 +262,27 @@
</para>
</section>
+<section id='ref-classes-packagegroup'>
+ <title>Package Groups - <filename>packagegroup.bbclass</filename></title>
+
+ <para>
+ This class sets default values appropriate for package group recipes (such as
+ <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>,
+ <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>,
+ <filename><link linkend='var-ALLOW_EMPTY'>ALLOW_EMPTY</link></filename>,
+ etc.). It is highly recommended that all package group recipes inherit this class.
+ </para>
+ <para>
+ For information on how to use this class, see the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>"
+ section in the Yocto Project Development Manual.
+ </para>
+ <para>
+ Previously this class was named task.bbclass.
+ </para>
+</section>
+
+
<section id='ref-classes-package'>
<title>Packaging - <filename>package*.bbclass</filename></title>
@@ -659,7 +680,6 @@
sstate.bbclass
staging.bbclass
syslinux.bbclass
- task.bbclass
terminal.bbclass
tinderclient.bbclass
toolchain-scripts.bbclass
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 09/12] documentation/poky-ref-manual: update undocumented classes list
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (7 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 08/12] documentation/poky-ref-manual: add packagegroup.bbclass to classes Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 10/12] documentation/poky-ref-manual: update images reference section Paul Eggleton
` (2 subsequent siblings)
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-classes.xml | 28 +++++++++++++++++++++++--
1 file changed, 26 insertions(+), 2 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index b836e2c..9e07c62 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -623,33 +623,54 @@
<!-- Undocumented classes are:
allarch.bbclass
+ archive*.bbclass
binconfig.bbclass
+ blacklist.bbclass
bootimg.bbclass
+ boot-directdisk.bbclass
+ bugzilla.bbclass
+ buildhistory.bbclass
buildstats.bbclass
- ccache.inc
+ ccache.bbclass
+ chrpath.bbclass
cmake.bbclass
cml1.bbclass
+ copyleft_compliance.bbclass
+ core-image.bbclass
cross.bbclass
cross-canadian.bbclass
+ crosssdk.bbclass
deploy.bbclass
distrodata.bbclass
+ dummy.bbclass
gconf.bbclass
gettext.bbclass
+ gnomebase.bbclass
gnome.bbclass
gtk-doc.bbclass
gtk-icon-cache.bbclass
+ gzipnative.bbclass
icecc.bbclass
+ image-empty.bbclass
+ image-live.bbclass
+ image-vmdk.bbclass
image-mklibs.bbclass
image-prelink.bbclass
image-swab.bbclass
imagetest-dummy.bbclass
imagetest-qemu.bbclass
+ image_types.bbclass
+ image_types_uboot.bbclass
insserv.bbclass
+ kernel-arch.bbclass
+ kernel-yocto.bbclass
lib_package.bbclass
+ linux-kernel-base.bbclass
license.bbclass
logging.bbclass
meta.bbclass
metadata_scm.bbclass
+ mime.bbclass
mirrors.bbclass
multilib*.bbclass
native.bbclass
@@ -657,14 +678,17 @@
oelint.bbclass
own-mirrors.bbclass
packagedata.bbclass
- packagehistory.bbclass
+ packageinfo.bbclass
patch.bbclass
perlnative.bbclass
pkg_distribute.bbclass
pkg_metainfo.bbclass
populate_sdk*.bbclass
+ prexport.bbclass
+ primport.bbclass
prserv.bbclass
python-dir.bbclass
+ pythonnative.bbclass
qemu.bbclass
qmake*.bbclass
qt4*.bbclass
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 10/12] documentation/poky-ref-manual: update images reference section
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (8 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 09/12] documentation/poky-ref-manual: update undocumented classes list Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 11/12] documentation/yocto-project-qs: adjust GUI component feature listing Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 12/12] documentation/poky-ref-manual: remove references to Dates and Contacts Paul Eggleton
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
* core-image-core was renamed to core-image-x11 and the editor and file
manager were removed.
* core-image-basic's description has been updated to reflect its
intended purpose
* core-image-lsb is intended to be standalone - should not be
associated with core-image-basic.
* The Pimlico applications have been removed so they are no longer
present in the Sato images.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-images.xml | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml
index d1ff6d0..186d688 100644
--- a/documentation/poky-ref-manual/ref-images.xml
+++ b/documentation/poky-ref-manual/ref-images.xml
@@ -40,9 +40,6 @@
<itemizedlist>
<listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
A console-only image that fully supports the target device hardware.</para></listitem>
- <listitem><para><emphasis><filename>core-image-core</filename>:</emphasis>
- An X11 image with simple applications such as terminal, editor, and file manager.
- </para></listitem>
<listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
A small image just capable of allowing a device to boot.</para></listitem>
<listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
@@ -61,12 +58,14 @@
for the Minimal MTD Utilities, which let the user interact with the
MTD subsystem in the kernel to perform operations on flash devices.
</para></listitem>
+ <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
+ A very basic X11 image with a terminal.
+ </para></listitem>
<listitem><para><emphasis><filename>core-image-basic</filename>:</emphasis>
- A foundational basic image without support for X that can be reasonably used for
- customization.</para></listitem>
+ A console-only image with more full-featured Linux system
+ functionality installed.</para></listitem>
<listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
- A <filename>core-image-basic</filename> image suitable for implementations
- that conform to Linux Standard Base (LSB).</para></listitem>
+ An image that conforms to the Linux Standard Base (LSB) specification.</para></listitem>
<listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
A <filename>core-image-lsb</filename> image that is suitable for development work
using the host.
@@ -83,8 +82,8 @@
<listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
An image with Sato support, a mobile environment and visual style that works well
with mobile devices.
- The image supports X11 with a Sato theme and Pimlico applications and also
- contains terminal, editor, and file manager.</para></listitem>
+ The image supports X11 with a Sato theme and applications such as
+ a terminal, editor, file manager, media player etc.</para></listitem>
<listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
A <filename>core-image-sato</filename> image suitable for development
using the host.
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 11/12] documentation/yocto-project-qs: adjust GUI component feature listing
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (9 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 10/12] documentation/poky-ref-manual: update images reference section Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
2012-09-05 14:35 ` [yocto-docs][PATCH 12/12] documentation/poky-ref-manual: remove references to Dates and Contacts Paul Eggleton
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
List frameworks we provide that are likely to be used by people these
days - Pimlico has been removed and GuPNP and Matchbox don't really
belong. Also slightly modify the sentence following so that it is clear
that these are optional.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
.../yocto-project-qs/yocto-project-qs.xml | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 94c488f..0e85d74 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -104,11 +104,11 @@
<para>Provides a recent Linux kernel along with a set of system commands and libraries suitable for the embedded environment.</para>
</listitem>
<listitem>
- <para>Makes available system components such as X11, Matchbox, GTK+, Pimlico, Clutter,
- GuPNP and Qt (among others) so you can create a richer user interface experience on
- devices that use displays or have a GUI.
- For devices that don't have a GUI or display, you simply would not employ these
- components.</para>
+ <para>Makes available system components such as X11, GTK+, Qt, Clutter, and SDL
+ (among others) so you can create a rich user experience on devices
+ that have display hardware.
+ For devices that don't have a display or wish to use alternative UI
+ frameworks, these components need not be installed.</para>
</listitem>
<listitem>
<para>Creates a focused and stable core compatible with the OpenEmbedded
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread* [yocto-docs][PATCH 12/12] documentation/poky-ref-manual: remove references to Dates and Contacts
2012-09-05 14:34 [yocto-docs][PATCH 00/12] Documentation fixes Paul Eggleton
` (10 preceding siblings ...)
2012-09-05 14:35 ` [yocto-docs][PATCH 11/12] documentation/yocto-project-qs: adjust GUI component feature listing Paul Eggleton
@ 2012-09-05 14:35 ` Paul Eggleton
11 siblings, 0 replies; 13+ messages in thread
From: Paul Eggleton @ 2012-09-05 14:35 UTC (permalink / raw)
To: yocto
Update the BitBake "Preferences and Providers" section to remove
references to these two Pimlico applications that have been removed,
and tweak the example slightly so it is technically correct.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index ff8db59..5055048 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -124,10 +124,10 @@
Once a provider is selected, BitBake resolves all the dependencies for
the target.
In the case of <filename>core-image-sato</filename>, it would lead to
- <filename>packagegroup-base.bb</filename>,
- which in turn leads to packages like <filename>Contacts</filename>,
- <filename>Dates</filename> and <filename>BusyBox</filename>.
- These packages in turn depend on <filename>eglibc</filename> and the toolchain.
+ <filename>packagegroup-core-x11-sato</filename>,
+ which in turn leads to recipes like <filename>matchbox-terminal</filename>,
+ <filename>pcmanfm</filename> and <filename>gthumb</filename>.
+ These recipes in turn depend on <filename>eglibc</filename> and the toolchain.
</para>
<para>
--
1.7.9.5
^ permalink raw reply related [flat|nested] 13+ messages in thread