* [PATCH 01/16] documentation/poky-ref-manual/poky-ref-manual.xml: Updated rev-history table
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
@ 2011-04-05 13:32 ` Scott Rifenbark
2011-04-05 13:32 ` [PATCH 02/16] documentation/poky-ref-manual/development.xml: Edits for Eclipse and Anjuta Scott Rifenbark
` (15 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:32 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Updated the revision history table for the manual.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/poky-ref-manual.xml | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/poky-ref-manual/poky-ref-manual.xml b/documentation/poky-ref-manual/poky-ref-manual.xml
index ed720c4..874d9a1 100644
--- a/documentation/poky-ref-manual/poky-ref-manual.xml
+++ b/documentation/poky-ref-manual/poky-ref-manual.xml
@@ -48,9 +48,9 @@
<revremark>Poky Master Documentation</revremark>
</revision>
<revision>
- <revnumber>1.0</revnumber>
+ <revnumber>5.0+git</revnumber>
<date>6 April 2011</date>
- <revremark>Poky documentation releasing with the Yocto Project 1.0 Release.</revremark>
+ <revremark>Released with Yocto Project 1.0 (Bernard 5.0).</revremark>
</revision>
</revhistory>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 02/16] documentation/poky-ref-manual/development.xml: Edits for Eclipse and Anjuta
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
2011-04-05 13:32 ` [PATCH 01/16] documentation/poky-ref-manual/poky-ref-manual.xml: Updated rev-history table Scott Rifenbark
@ 2011-04-05 13:32 ` Scott Rifenbark
2011-04-05 13:32 ` [PATCH 03/16] documentation/poky-ref-manual/development.xml: Corrected command syntax Scott Rifenbark
` (14 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:32 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
I commented out a large section of the chapter, which went into detail
on how to locate, install, configure, and use the Yocto Ecliple
plug-in. This information is redundant in this book and is better
explained in the ADT Manual. I am referencing the information from
this chapter now.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/development.xml | 46 ++++++++++++++++++++-----
1 files changed, 37 insertions(+), 9 deletions(-)
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index db844a9..e63511b 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -12,7 +12,7 @@
</para>
<section id="platdev-appdev-external-sdk">
- <title>External Development Using the Poky SDK</title>
+ <title>External Development Using the Application Development Toolkit (ADT)</title>
<para>
The meta-toolchain and meta-toolchain-sdk targets build tarballs that contain toolchains and
libraries suitable for application development outside of Poky.
@@ -45,17 +45,41 @@
</section>
<section id="using-the-eclipse-and-anjuta-plug-ins">
- <title>Using the Eclipse and Anjuta Plug-ins</title>
+ <title>Using the Eclipse Plug-in</title>
<para>
- Yocto Project supports both Anjuta and Eclipse IDE plug-ins to make developing software
- easier for the application developer. The plug-ins provide capability
- extensions to the graphical IDE allowing for cross compilation,
- deployment and execution of the output in a QEMU emulation session.
- Support of these plug-ins also allows for cross debugging and
- profiling. Additionally, the Eclipse plug-in provides a suite of tools
+ The current release of the Yocto Project supports the Eclipse IDE plug-in
+ to make developing software easier for the application developer.
+ The plug-in provides capability extensions to the graphical IDE to allow
+ for cross compilation, deployment and execution of the output in a QEMU
+ emulation session.
+ Support of the Eclipse plug-in also allows for cross debugging and
+ profiling.
+ Additionally, the Eclipse plug-in provides a suite of tools
that allows the developer to perform remote profiling, tracing, collection of
power data, collection of latency data and collection of performance data.
</para>
+ <note>
+ The current release of the Yocto Project no longer supports the Anjuta plug-in.
+ However, the Poky Anjuta Plug-in is available to download directly from the Poky
+ Git repository located through the web interface at
+ <ulink url="http://git.yoctoproject.org/"></ulink> under IDE Plugins.
+ The community is free to continue supporting it beyond the Yocto Project 0.9
+ Release.
+ </note>
+ <para>
+ To use the Eclipse plug-in you need the Eclipse Framework (Helios 3.6.1) along
+ with other plug-ins installed into the Eclipse IDE.
+ Once you have your environment setup you need to configure the Eclipse plug-in.
+ For information on how to install and configure the Eclipse plug-in, see the
+ <ulink url='http://www.yoctoproject.org/docs/adt-manual/adt-manual.html#adt-eclipse'>
+ "Working Within Eclipse"</ulink> chapter in the
+ <ulink url='http://www.yoctoproject.org/docs/adt-manual/adt-manual.html'>
+ "Application Development Toolkit (ADT) User's Guide."</ulink>
+ </para>
+
+
+
+<!--
<section id="the-eclipse-plug-in">
<title>The Eclipse Plug-in</title>
@@ -309,7 +333,7 @@
<para>
See the README file contained in the project for more information on
Anjuta dependencies and building the plug-in.
- If you want to disable remote gdb debugging, pass the "--disable-gdb-integration" switch when
+ If you want to disable remote gdb debugging, pass the "‐‐disable-gdb-integration" switch when
you configure the plug-in.
</para>
<section id="setting-up-the-anjuta-plugin">
@@ -416,6 +440,10 @@
</para>
</section>
</section>
+
+
+-->
+
</section>
<section id="platdev-appdev-qemu">
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 03/16] documentation/poky-ref-manual/development.xml: Corrected command syntax
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
2011-04-05 13:32 ` [PATCH 01/16] documentation/poky-ref-manual/poky-ref-manual.xml: Updated rev-history table Scott Rifenbark
2011-04-05 13:32 ` [PATCH 02/16] documentation/poky-ref-manual/development.xml: Edits for Eclipse and Anjuta Scott Rifenbark
@ 2011-04-05 13:32 ` Scott Rifenbark
2011-04-05 13:32 ` [PATCH 04/16] documentation/poky-ref-manual/development.xml: OProfileUI section updated Scott Rifenbark
` (13 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:32 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
In section 5.2.2. (Building the Cross-GDB Package) there was a resulting
directory listed where you could find the binary. The directory had
a couple of variables for 'host-arch' and 'target-abi'. There was
a mis-guided angle bracket wrapping the 'host-arch' variable. This
was fixed.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/development.xml | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index e63511b..5479854 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -719,7 +719,7 @@
</literallayout>
Once the binary is built you can find it here:
<programlisting>
-tmp/sysroots/<host-arch</usr/bin/<target-abi>-gdb
+tmp/sysroots/<host-arch>/usr/bin/<target-abi>-gdb
</programlisting>
</para>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 04/16] documentation/poky-ref-manual/development.xml: OProfileUI section updated
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (2 preceding siblings ...)
2011-04-05 13:32 ` [PATCH 03/16] documentation/poky-ref-manual/development.xml: Corrected command syntax Scott Rifenbark
@ 2011-04-05 13:32 ` Scott Rifenbark
2011-04-05 13:32 ` [PATCH 05/16] documentation/poky-ref-manual/ref-structure.xml: bitbake " Scott Rifenbark
` (12 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:32 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Section 5.3.2 (Using OProfileUI) was out of date. Several of the URLs
would not resolve. They were pointing to openedhand links that had
not been maintained. I updated the entire section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/development.xml | 13 ++++++-------
1 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index 5479854..45df028 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -937,8 +937,8 @@ $ opreport -cl
<para>
A graphical user interface for OProfile is also available.
- You can download and build it from svn at
- <ulink url="http://svn.o-hand.com/repos/oprofileui/trunk/"></ulink>.
+ You can download and build it from the Yocto Project at
+ <ulink url="http://git.yoctoproject.org/cgit.cgi/oprofileui/"></ulink>.
If the "tools-profile" image feature is selected, all necessary binaries
are installed onto the target device for OProfileUI interaction.
</para>
@@ -954,7 +954,7 @@ $ opreport -cl
</caption>
</mediaobject>
</screenshot>
--->
+
<para>
In order to convert the data in the sample format from the target
to the host you need the <filename>opimport</filename> program.
@@ -963,13 +963,12 @@ $ opreport -cl
<ulink url='http://debian.o-hand.com/'>OpenedHand repository</ulink>.
We recommend using OProfile 0.9.3 or greater.
</para>
+-->
<para>
Even though Poky usually includes all needed patches on the target device, you
might find you need other OProfile patches for recent OProfileUI features.
- If so, see the <ulink url='http://svn.o-hand.com/repos/oprofileui/trunk/README'>
+ If so, see the <ulink url='http://git.yoctoproject.org/cgit.cgi/oprofileui/tree/README'>
OProfileUI README</ulink> for the most recent information.
- You can also see <ulink url="http://labs.o-hand.com/oprofileui">OProfileUI website
- </ulink> for general information on the OProfileUI project.
</para>
<section id="platdev-oprofile-oprofileui-online">
@@ -1066,7 +1065,7 @@ $ opreport -cl
a "vmlinux" file that matches the running kernel is available.
In Poky, that file is usually located in
<filename>/boot/vmlinux-KERNELVERSION</filename>, where KERNEL-version is the
- version of the kernel (e.g. 2.6.23).
+ version of the kernel.
Poky generates separate vmlinux packages for each kernel
it builds so it should be a question of just making sure a matching package is
installed - for example: <filename>opkg install kernel-vmlinux</filename>.
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 05/16] documentation/poky-ref-manual/ref-structure.xml: bitbake section updated
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (3 preceding siblings ...)
2011-04-05 13:32 ` [PATCH 04/16] documentation/poky-ref-manual/development.xml: OProfileUI section updated Scott Rifenbark
@ 2011-04-05 13:32 ` Scott Rifenbark
2011-04-05 13:32 ` [PATCH 06/16] documentation/poky-ref-manual/ref-bitbake.xml: removed 'varname' style Scott Rifenbark
` (11 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:32 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Section A.1.1 (bitbake/) contained two URLs. One supposedly went to
a BitBake site and the other to the BitBake online manual. In reality,
they both went to the online manual. I removed the one referencing
the site.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-structure.xml | 5 ++---
1 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index 74687c5..7ebf9bd 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -32,9 +32,8 @@
</para>
<para>
- For more information on BitBake, see the BitBake project site at
- <ulink url="http://bitbake.berlios.de/"/>
- and the BitBake on-line manual at <ulink url="http://bitbake.berlios.de/manual/"/>.
+ For more information on BitBake, see the BitBake on-line manual at
+ <ulink url="http://bitbake.berlios.de/manual/"/>.
</para>
</section>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 06/16] documentation/poky-ref-manual/ref-bitbake.xml: removed 'varname' style
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (4 preceding siblings ...)
2011-04-05 13:32 ` [PATCH 05/16] documentation/poky-ref-manual/ref-structure.xml: bitbake " Scott Rifenbark
@ 2011-04-05 13:32 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 07/16] documentation/poky-ref-manual/ref-bitbake.xml: Grammar fix Scott Rifenbark
` (10 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:32 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
I replaced varname style with filename style. Looks better. We have
too many styles.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 6 +++---
1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 1a98b04..8076066 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -34,7 +34,7 @@
<para>
The first thing BitBake does is look for the <filename>bitbake.conf</filename> file.
Poky keeps this file in <filename class="directory">meta/conf/</filename>.
- BitBake finds it by examining the <varname>BBPATH</varname> environment
+ BitBake finds it by examining the <filename>BBPATH</filename> environment
variable and looking for the <filename class="directory">meta/conf/</filename>
directory.
</para>
@@ -42,7 +42,7 @@
<para>
In Poky, <filename>bitbake.conf</filename> lists other configuration
files to include from a <filename class="directory">conf/</filename>
- directory below the directories listed in <varname>BBPATH</varname>.
+ directory below the directories listed in <filename>BBPATH</filename>.
In general the most important configuration file from a user's perspective
is <filename>local.conf</filename>, which contains a user's customized
settings for Poky.
@@ -70,7 +70,7 @@
<glossterm><link linkend='var-INHERIT'>INHERIT</link></glossterm>
variable are also inculded.
Class files are searched for in a classes subdirectory
- under the paths in <varname>BBPATH</varname> in the same way as
+ under the paths in <filename>BBPATH</filename> in the same way as
configuration files.
</para>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 07/16] documentation/poky-ref-manual/ref-bitbake.xml: Grammar fix
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (5 preceding siblings ...)
2011-04-05 13:32 ` [PATCH 06/16] documentation/poky-ref-manual/ref-bitbake.xml: removed 'varname' style Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 08/16] documentation/poky-ref-manual/ref-bitbake.xml: type fixed Scott Rifenbark
` (9 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Section B.2 (Preferences and Providers) had a grammar error.
It said "An common example is..." I fixed it.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 8076066..8848190 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -125,7 +125,7 @@
<para>
Sometimes a target might have multiple providers.
- An common example is "virtual/kernel", which is provided by each kernel package.
+ A common example is "virtual/kernel", which is provided by each kernel package.
Each machine often elects the best kernel provider by using a line similar to the
following in the machine configuration file:
</para>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 08/16] documentation/poky-ref-manual/ref-bitbake.xml: type fixed
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (6 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 07/16] documentation/poky-ref-manual/ref-bitbake.xml: Grammar fix Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 09/16] document/poky-ref-manual/ref-classes.xml: removed <function> tag Scott Rifenbark
` (8 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Section B.4 (The Task List) had the typo "taksks". Changed to
"tasks."
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 8848190..4bea1e4 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -195,7 +195,7 @@ PREFERRED_PROVIDER_virtual/kernel = "linux-rp"
The build now starts with BitBake forking off threads up to the limit set in the
<glossterm><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link></glossterm> variable.
BitBake continues to fork threads as long as there are tasks ready to run,
- those taksks have all their dependencies met, and the thread threshold has not been
+ those tasks have all their dependencies met, and the thread threshold has not been
exceeded.
</para>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 09/16] document/poky-ref-manual/ref-classes.xml: removed <function> tag
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (7 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 08/16] documentation/poky-ref-manual/ref-bitbake.xml: type fixed Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 10/16] documentation/poky-ref-manual/ref-classes.xml: Fix to <filename> tag Scott Rifenbark
` (7 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
I got rid of the <function> tag and replaced with <filename>. We
have too many styles.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-classes.xml | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index d7cfb6e..9082aa7 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -35,7 +35,7 @@
(empty by default). These are often overridden or extended by other classes
such as <filename>autotools.bbclass</filename> or
<filename>package.bbclass</filename>. The class also contains some commonly
- used functions such as <function>oe_runmake</function>.
+ used functions such as <variable>oe_runmake</variable>.
</para>
</section>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 10/16] documentation/poky-ref-manual/ref-classes.xml: Fix to <filename> tag
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (8 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 09/16] document/poky-ref-manual/ref-classes.xml: removed <function> tag Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 11/16] documentation/poky-ref-manual/ref-classes.xml: re-write of autotooled packages Scott Rifenbark
` (6 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Had to fix the <variable> tag by replacing it with <filename>.
Previous commit didn't work so this is fixing it.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-classes.xml | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index 9082aa7..0cb2fce 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -35,7 +35,7 @@
(empty by default). These are often overridden or extended by other classes
such as <filename>autotools.bbclass</filename> or
<filename>package.bbclass</filename>. The class also contains some commonly
- used functions such as <variable>oe_runmake</variable>.
+ used functions such as <filename>oe_runmake</filename>.
</para>
</section>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 11/16] documentation/poky-ref-manual/ref-classes.xml: re-write of autotooled packages
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (9 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 10/16] documentation/poky-ref-manual/ref-classes.xml: Fix to <filename> tag Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 12/16] documentation/poky-ref-manual/ref-classes.xml: tag updates Scott Rifenbark
` (5 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Section C.2 (Autotooled Packages) was re-written. I removed a bunch
of <variable> tags and replaced them with <filename>. Also removed
some Britishisms.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-classes.xml | 39 +++++++++++++-----------
1 files changed, 21 insertions(+), 18 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index 0cb2fce..1402955 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -15,7 +15,7 @@
by BUILDDIR (e.g. <filename class="directory">build/</filename>)in the same way as
<filename class="extension">.conf</filename> files in the <filename
class="directory">conf</filename> directory. Class files are searched for
- in BBPATH in the same was as <filename class="extension">.conf</filename> files too.
+ in BBPATH in the same was as <filename>.conf</filename> files too.
</para>
<para>
@@ -43,13 +43,13 @@
<title>Autotooled Packages - <filename>autotools.bbclass</filename></title>
<para>
- Autotools (autoconf, automake, libtool) brings standardisation and this
- class aims to define a set of tasks (configure, compile etc.) that will
- work for all autotooled packages. It should usually be enough to define
- a few standard variables as documented in the <link
- linkend='usingpoky-extend-addpkg-autotools'>simple autotools
- example</link> section and then simply "inherit autotools". This class
- can also work with software that emulates autotools.
+ Autotools (autoconf, automake, libtool) bring standardization.
+ This class defines a set of tasks (configure, compile etc.) that
+ work for all autotooled packages.
+ It should usually be enough to define a few standard variables as documented in the
+ <link linkend='usingpoky-extend-addpkg-autotools'>simple autotools
+ example</link> section and then simply "inherit autotools".
+ This class can also work with software that emulates autotools.
</para>
<para>
@@ -60,26 +60,29 @@
<itemizedlist>
<listitem>
<para>
- 'do_configure' regenerates the configure script (using autoreconf) and
- then launches it with a standard set of arguments used during
- cross-compilation. Additional parameters can be passed to
- <command>configure</command> through the <glossterm><link
- linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></glossterm> variable.
+ <filename>do_configure</filename> ‐ regenerates the configure script (using autoreconf)
+ and then launches it with a standard set of arguments used during
+ cross-compilation.
+ You can pass additional parameters to
+ <filename>configure</filename> through the
+ <glossterm><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></glossterm> variable.
</para>
</listitem>
<listitem>
<para>
- 'do_compile' runs <command>make</command> with arguments specifying
- the compiler and linker. Additional arguments can be passed through
+ <filename>do_compile</filename> ‐ runs <filename>make</filename> with
+ arguments that specify the compiler and linker.
+ You can pass additional arguments through
the <glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
</glossterm> variable.
</para>
</listitem>
<listitem>
<para>
- 'do_install' runs <command>make install</command> passing a DESTDIR
- option taking its value from the standard <glossterm><link
- linkend='var-DESTDIR'>DESTDIR</link></glossterm> variable.
+ <filename>do_install</filename> ‐ runs <filename>make install</filename>
+ and passes a <filename>DESTDIR</filename>
+ option, which takes its value from the standard
+ <glossterm><link linkend='var-DESTDIR'>DESTDIR</link></glossterm> variable.
</para>
</listitem>
</itemizedlist>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 12/16] documentation/poky-ref-manual/ref-classes.xml: tag updates
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (10 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 11/16] documentation/poky-ref-manual/ref-classes.xml: re-write of autotooled packages Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 13/16] documentation/poky-ref-manual/ref-structure.xml: Edits for Rel 1.0 Scott Rifenbark
` (4 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Removed the various styles for commands and such and replaced with
simple <filename>/</filename> pairs.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-classes.xml | 87 +++++++++----------------
1 files changed, 32 insertions(+), 55 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index 1402955..8eb94c2 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -6,14 +6,14 @@
<para>
Class files are used to abstract common functionality and share it amongst multiple
- <filename class="extension">.bb</filename> files. Any metadata usually found in a
- <filename class="extension">.bb</filename> file can also be placed in a class
+ <filename>.bb</filename> files. Any metadata usually found in a
+ <filename>.bb</filename> file can also be placed in a class
file. Class files are identified by the extension
- <filename class="extension">.bbclass</filename> and are usually placed
- in a <filename class="directory">classes/</filename> directory beneath the
- <filename class="directory">meta*/</filename> directory or the directory pointed
- by BUILDDIR (e.g. <filename class="directory">build/</filename>)in the same way as
- <filename class="extension">.conf</filename> files in the <filename
+ <filename>.bbclass</filename> and are usually placed
+ in a <filename>classes/</filename> directory beneath the
+ <filename>meta*/</filename> directory or the directory pointed
+ by BUILDDIR (e.g. <filename>build/</filename>)in the same way as
+ <filename>.conf</filename> files in the <filename
class="directory">conf</filename> directory. Class files are searched for
in BBPATH in the same was as <filename>.conf</filename> files too.
</para>
@@ -28,7 +28,7 @@
<title>The base class - <filename>base.bbclass</filename></title>
<para>
- The base class is special in that every <filename class="extension">.bb</filename>
+ The base class is special in that every <filename>.bb</filename>
file inherits it automatically. It contains definitions of standard basic
tasks such as fetching, unpacking, configuring (empty by default), compiling
(runs any Makefile present), installing (empty by default) and packaging
@@ -94,54 +94,31 @@
<para>
Several programs can fulfill the same or similar function and
- they can be installed with the same name. For example the <command>ar</command>
+ be installed with the same name.
+ For example, the <filename>ar</filename>
command is available from the "busybox", "binutils" and "elfutils" packages.
- This class handles the renaming of the binaries so multiple packages
- can be installed which would otherwise conflict and yet the
- <command>ar</command> command still works regardless of which are installed
- or subsequently removed. It renames the conflicting binary in each package
+ The <filename>update-alternatives.bbclass</filename> class handles renaming the
+ binaries so that multiple packages can be installed without conflicts.
+ The <filename>ar</filename> command still works regardless of which packages are installed
+ or subsequently removed.
+ The class renames the conflicting binary in each package
and symlinks the highest priority binary during installation or removal
of packages.
-
+ </para>
+ <para>
Four variables control this class:
</para>
-
-
- <variablelist>
- <varlistentry>
- <term>ALTERNATIVE_NAME</term>
- <listitem>
- <para>
- Name of binary which will be replaced (<command>ar</command> in this example)
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ALTERNATIVE_LINK</term>
- <listitem>
- <para>
- Path to resulting binary ("/bin/ar" in this example)
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ALTERNATIVE_PATH</term>
- <listitem>
- <para>
- Path to real binary ("/usr/bin/ar.binutils" in this example)
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ALTERNATIVE_PRIORITY</term>
- <listitem>
- <para>
- Priority of binary, the version with the most features should have the highest priority
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
+ <itemizedlist>
+ <listitem><para><filename>ALTERNATIVE_NAME</filename> ‐ The name of the
+ binary that is replaced (<filename>ar</filename> in this example).</para></listitem>
+ <listitem><para><filename>ALTERNATIVE_LINK</filename> ‐ The path to
+ the resulting binary (<filename>/bin/ar</filename> in this example).</para></listitem>
+ <listitem><para><filename>ALTERNATIVE_PATH</filename> ‐ The path to the
+ real binary (<filename>/usr/bin/ar.binutils</filename> in this example).</para></listitem>
+ <listitem><para><filename>ALTERNATIVE_PRIORITY</filename> ‐ The priority of
+ the binary.
+ The version with the most features should have the highest priority.</para></listitem>
+ </itemizedlist>
<para>
Currently, only one binary per package is supported.
</para>
@@ -175,7 +152,7 @@
<para>
During staging Bitbake installs such scripts into the <filename
class="directory">sysroots/</filename> directory. It also changes all
- paths to point into the <filename class="directory">sysroots/</filename>
+ paths to point into the <filename>sysroots/</filename>
directory so all builds which use the script will use the correct
directories for the cross compiling layout.
</para>
@@ -218,7 +195,7 @@
</para>
<para>
- Result of their work are <filename class="directory">tmp/deploy/source/</filename>
+ Result of their work are <filename>tmp/deploy/source/</filename>
subdirs with sources sorted by <glossterm><link linkend='var-LICENSE'>LICENSE</link>
</glossterm> field. If recipe lists few licenses (or has entries like "Bitstream Vera") source archive is put in each
license dir.
@@ -322,7 +299,7 @@
</para>
<para>
This means that each kernel module built is packaged separately and inter-module dependencies are
- created by parsing the <command>modinfo</command> output. If all modules are
+ created by parsing the <filename>modinfo</filename> output. If all modules are
required then installing the "kernel-modules" package will install all
packages with modules and various other kernel packages such as "kernel-vmlinux".
</para>
@@ -406,7 +383,7 @@
<para>
Only the most useful/important classes are covered here but there are
- others, see the <filename class="directory">meta/classes</filename> directory for the rest.
+ others, see the <filename>meta/classes</filename> directory for the rest.
</para>
</section>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 13/16] documentation/poky-ref-manual/ref-structure.xml: Edits for Rel 1.0
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (11 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 12/16] documentation/poky-ref-manual/ref-classes.xml: tag updates Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 14/16] documentation/poky-ref-manual/ref-variables.xml: added SSTATE_DIR variable Scott Rifenbark
` (3 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
These edits reflect changes in the directory structure from the 0.9
version of the software to the 1.0 version. This set of changes still
is missing a few items. Changes were based on Saul Wold's input.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-structure.xml | 103 +++++++++++++++++++++--
1 files changed, 97 insertions(+), 6 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index 7ebf9bd..4cfd08f 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -61,7 +61,7 @@
</para>
</section>
- <section id='structure-core-meta-extras'>
+<!-- <section id='structure-core-meta-extras'>
<title><filename class="directory">meta-extras/</filename></title>
<para>
@@ -70,8 +70,25 @@
This metadata is disabled by default and is not supported as part of Poky.
</para>
</section>
+-->
+
+ <section id='structure-core-meta-demoapps'>
+ <title><filename class="directory">meta-demoapps/</filename></title>
+
+ <para>
+ This directory contains recipes for applications and demos that are not core.
+ </para>
+ </section>
+
+ <section id='structure-core-meta-rt'>
+ <title><filename class="directory">meta-rt/</filename></title>
- <section id='structure-core-meta-***'>
+ <para>
+ This directory contains recipes for RealTime.
+ </para>
+ </section>
+
+<!-- <section id='structure-core-meta-***'>
<title><filename class="directory">meta-***/</filename></title>
<para>
@@ -79,6 +96,7 @@
The layers are enabled by adding them to the <filename>conf/bblayers.conf</filename> file.
</para>
</section>
+-->
<section id='structure-core-scripts'>
<title><filename class="directory">scripts/</filename></title>
@@ -91,7 +109,7 @@
</para>
</section>
- <section id='structure-core-sources'>
+<!-- <section id='structure-core-sources'>
<title><filename class="directory">sources/</filename></title>
<para>
@@ -123,6 +141,7 @@
<filename class="extension">.md5</filename> file as well.
</para>
</section>
+-->
<section id='handbook'>
<title><filename class="directory">documentation</filename></title>
@@ -159,11 +178,28 @@
like Poky to generate the build output.
</para>
</section>
+
+ <section id='structure-basic-top-level'>
+ <title><filename>LICENSE, README, and README.hardware</filename></title>
+
+ <para>
+ These files are standard top-level files.
+ </para>
+ </section>
</section>
<section id='structure-build'>
<title>The Build Directory - <filename class="directory">build/</filename></title>
+ <section id='structure-build-pseudodone'>
+ <title><filename>build/pseudodone</filename></title>
+
+ <para>
+ This tag file indicates that the intitial pseudo binar was created.
+ The first time BitBake is invoked this file is built.
+ </para>
+ </section>
+
<section id='structure-build-conf-local.conf'>
<title><filename>build/conf/local.conf</filename></title>
@@ -197,6 +233,36 @@
</para>
</section>
+ <section id='structure-build-conf-sanity_info'>
+ <title><filename>build/conf/sanity_info</filename></title>
+
+ <para>
+ This file is created during the build to indicate the state of the sanity checks.
+ </para>
+ </section>
+
+ <section id='structure-build-downloads'>
+ <title><filename>build/downloads/</filename></title>
+
+ <para>
+ This directory is used for the upstream source tarballs.
+ The directory can be reused by multiple builds or moved to another location.
+ You can control the location of this directory through the
+ <glossterm><link linkend='var-DL_DIR'>DL_DIR</link></glossterm> variable.
+ </para>
+ </section>
+
+ <section id='structure-build-sstate-cache'>
+ <title><filename>build/sstate-cache/</filename></title>
+
+ <para>
+ This directory is used for the shared state cache.
+ The directory can be reused by multiple builds or moved to another location.
+ You can control the location of this directory through the
+ <glossterm><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></glossterm> variable.
+ </para>
+ </section>
+
<section id='structure-build-tmp'>
<title><filename class="directory">build/tmp/</filename></title>
@@ -210,6 +276,14 @@
</para>
</section>
+ <section id='structure-build-tmp-buildstats'>
+ <title><filename class="directory">build/tmp/buildstats/</filename></title>
+
+ <para>
+ This directory stores the build statistics.
+ </para>
+ </section>
+
<section id='structure-build-tmp-cache'>
<title><filename class="directory">build/tmp/cache/</filename></title>
@@ -230,7 +304,7 @@
<title><filename class="directory">build/tmp/deploy/deb/</filename></title>
<para>
- This directory receives any .deb packages produced by Poky.
+ This directory receives any <filename>.deb</filename> packages produced by Poky.
The packages are sorted into feeds for different architecture types.
</para>
</section>
@@ -239,7 +313,7 @@
<title><filename class="directory">build/tmp/deploy/rpm/</filename></title>
<para>
- This directory receives any .rpm packages produced by Poky.
+ This directory receives any <filename>.rpm</filename> packages produced by Poky.
The packages re sorted into feeds for different architecture types.
</para>
</section>
@@ -256,7 +330,7 @@
<section id='structure-build-tmp-deploy-ipk'>
<title><filename class="directory">build/tmp/deploy/ipk/</filename></title>
- <para>This directory receives .ipk packages produced by Poky.</para>
+ <para>This directory receives <filename>.ipk</filename> packages produced by Poky.</para>
</section>
<section id='structure-build-tmp-sysroots'>
@@ -512,6 +586,15 @@
</para>
</section>
+ <section id='structure-meta-recipes-support'>
+ <title><filename class="directory">meta/recipes-support/</filename></title>
+
+ <para>
+ This directory contains recipes that used by other recipes, but that are not directly
+ included in images (i.e. depenendies of other recipes).
+ </para>
+ </section>
+
<section id='structure-meta-site'>
<title><filename class="directory">meta/site/</filename></title>
@@ -522,6 +605,14 @@
passed to "autoconf" for the various architectures.
</para>
</section>
+
+ <section id='structure-meta-recipes-txt'>
+ <title><filename class="directory">meta/recipes.txt/</filename></title>
+
+ <para>
+ This file is a description of the contents of <filename>recipes-*</filename>.
+ </para>
+ </section>
</section>
</appendix>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 14/16] documentation/poky-ref-manual/ref-variables.xml: added SSTATE_DIR variable
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (12 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 13/16] documentation/poky-ref-manual/ref-structure.xml: Edits for Rel 1.0 Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 15/16] documentation/poky-ref-manual/ref-bitbake.xml: BitBake parsing section update Scott Rifenbark
` (2 subsequent siblings)
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Due to some changes in the file structure for 1.0 there is a new directory
for the shared state. The variable SSTATE_DIR can be used to point to
the directory. I added this variable to the list of documented variables.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 6 ++++++
1 files changed, 6 insertions(+), 0 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index da57e2c..2e3dbb6 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -766,6 +766,12 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
</glossdef>
</glossentry>
+ <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm>
+ <glossdef>
+ <para>Directory for the shared state.</para>
+ </glossdef>
+
+ </glossentry>
<glossentry id='var-SHELLCMDS'><glossterm>SHELLCMDS</glossterm>
<glossdef>
<para>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 15/16] documentation/poky-ref-manual/ref-bitbake.xml: BitBake parsing section update
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (13 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 14/16] documentation/poky-ref-manual/ref-variables.xml: added SSTATE_DIR variable Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-05 13:33 ` [PATCH 16/16] documentation/poky-ref-manual/ref-bitbake.xml: style tags updated Scott Rifenbark
2011-04-06 18:18 ` [PATCH 00/16] [DOCS] Poky Reference Manual Updates Richard Purdie
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
In section B.1 (Parsing) it said that BBFILES variable by default
specified the direcotyr 'meta/packages/' as the place to look for .bb
files. This directory is invalid and needed to be changed to
'meta/packages/'.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 6 ++----
1 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 4bea1e4..d870387 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -80,10 +80,8 @@
is set, usually in
<filename>local.conf</filename>, and defines the list of places to search for
<filename class="extension">.bb</filename> files.
- By default, the BBFILES variable specifies the <filename class="directory">meta/packages/
- </filename> directory within Poky, but other directories such as
- <filename class="directory">meta-extras/</filename> can be included
- too.
+ By default, the BBFILES variable specifies the <filename class="directory">meta/recipes-*/
+ </filename> directory within Poky.
Adding extra content to BBFILES is best achieved through the use of BitBake
<link linkend='usingpoky-changes-layers'>"layers"</link>.
</para>
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* [PATCH 16/16] documentation/poky-ref-manual/ref-bitbake.xml: style tags updated
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (14 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 15/16] documentation/poky-ref-manual/ref-bitbake.xml: BitBake parsing section update Scott Rifenbark
@ 2011-04-05 13:33 ` Scott Rifenbark
2011-04-06 18:18 ` [PATCH 00/16] [DOCS] Poky Reference Manual Updates Richard Purdie
16 siblings, 0 replies; 18+ messages in thread
From: Scott Rifenbark @ 2011-04-05 13:33 UTC (permalink / raw)
To: poky
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
I got rid of the <filename class='directory'...> and
<filename class='extension'...> and replaced with simple
<filename>/</filename> pairs.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 36 ++++++++++++------------
1 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index d870387..75b3bf5 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -33,15 +33,15 @@
<para>
The first thing BitBake does is look for the <filename>bitbake.conf</filename> file.
- Poky keeps this file in <filename class="directory">meta/conf/</filename>.
+ Poky keeps this file in <filename>meta/conf/</filename>.
BitBake finds it by examining the <filename>BBPATH</filename> environment
- variable and looking for the <filename class="directory">meta/conf/</filename>
+ variable and looking for the <filename>meta/conf/</filename>
directory.
</para>
<para>
In Poky, <filename>bitbake.conf</filename> lists other configuration
- files to include from a <filename class="directory">conf/</filename>
+ files to include from a <filename>conf/</filename>
directory below the directories listed in <filename>BBPATH</filename>.
In general the most important configuration file from a user's perspective
is <filename>local.conf</filename>, which contains a user's customized
@@ -54,11 +54,11 @@
The DISTRO and MACHINE environment variables are both usually set in
the <filename>local.conf</filename> file.
Valid distribution
- configuration files are available in the <filename class="directory">
+ configuration files are available in the <filename>
meta/conf/distro/</filename> directory and valid machine configuration
- files in the <filename class="directory">meta/conf/machine/</filename>
+ files in the <filename>meta/conf/machine/</filename>
directory.
- Within the <filename class="directory">meta/conf/machine/include/</filename>
+ Within the <filename>meta/conf/machine/include/</filename>
directory are various <filename>tune-*.inc</filename> configuration files that provide common
"tuning" settings specific to and shared between particular architectures and machines.
</para>
@@ -79,29 +79,29 @@
variable <glossterm><link linkend='var-BBFILES'>BBFILES</link></glossterm>
is set, usually in
<filename>local.conf</filename>, and defines the list of places to search for
- <filename class="extension">.bb</filename> files.
- By default, the BBFILES variable specifies the <filename class="directory">meta/recipes-*/
+ <filename>.bb</filename> files.
+ By default, the BBFILES variable specifies the <filename>meta/recipes-*/
</filename> directory within Poky.
Adding extra content to BBFILES is best achieved through the use of BitBake
<link linkend='usingpoky-changes-layers'>"layers"</link>.
</para>
<para>
- BitBake parses each <filename class="extension">.bb</filename> file in BBFILES and
+ BitBake parses each <filename>.bb</filename> file in BBFILES and
stores the values of various variables.
- In summary, for each <filename class="extension">.bb</filename>
+ In summary, for each <filename>.bb</filename>
file the configuration plus the base class of variables are set, followed
- by the data in the <filename class="extension">.bb</filename> file
+ by the data in the <filename>.bb</filename> file
itself, followed by any inherit commands that
- <filename class="extension">.bb</filename> file might contain.
+ <filename>.bb</filename> file might contain.
</para>
<para>
- Because parsing <filename class="extension">.bb</filename> files is a time
+ Because parsing <filename>.bb</filename> files is a time
consuming process, a cache is kept to speed up subsequent parsing.
- This cache is invalid if the timestamp of the <filename class="extension">.bb</filename>
+ This cache is invalid if the timestamp of the <filename>.bb</filename>
file itself changes, or if the timestamps of any of the include,
- configuration or class files the <filename class="extension">.bb</filename>
+ configuration or class files the <filename>.bb</filename>
file depends on changes.
</para>
</section>
@@ -110,7 +110,7 @@
<title>Preferences and Providers</title>
<para>
- Once all the <filename class="extension">.bb</filename> files have been
+ Once all the <filename>.bb</filename> files have been
parsed, BitBake starts to build the target (poky-image-sato in the previous section's
example) and looks for providers of that target.
Once a provider is selected, BitBake resolves all the dependencies for
@@ -200,11 +200,11 @@ PREFERRED_PROVIDER_virtual/kernel = "linux-rp"
<para>
As each task completes, a timestamp is written to the directory specified by the
<glossterm><link linkend='var-STAMPS'>STAMPS</link></glossterm> variable (usually
- <filename class="directory">build/tmp/stamps/*/</filename>).
+ <filename>build/tmp/stamps/*/</filename>).
On subsequent runs, BitBake looks at the STAMPS directory and does not rerun
tasks that are already completed unless a timestamp is found to be invalid.
Currently, invalid timestamps are only considered on a per
- <filename class="extension">.bb</filename> file basis.
+ <filename>.bb</filename> file basis.
So, for example, if the configure stamp has a timestamp greater than the
compile timestamp for a given target then the compile task would rerun.
Running the compile task again, however, has no effect on other providers
--
1.7.0.4
^ permalink raw reply related [flat|nested] 18+ messages in thread* Re: [PATCH 00/16] [DOCS] Poky Reference Manual Updates
2011-04-05 13:32 [PATCH 00/16] [DOCS] Poky Reference Manual Updates Scott Rifenbark
` (15 preceding siblings ...)
2011-04-05 13:33 ` [PATCH 16/16] documentation/poky-ref-manual/ref-bitbake.xml: style tags updated Scott Rifenbark
@ 2011-04-06 18:18 ` Richard Purdie
16 siblings, 0 replies; 18+ messages in thread
From: Richard Purdie @ 2011-04-06 18:18 UTC (permalink / raw)
To: Scott Rifenbark; +Cc: poky
On Tue, 2011-04-05 at 06:32 -0700, Scott Rifenbark wrote:
> From: Scott Rifenbark <scott.m.rifenbark@intel.com>
>
> These changes represent edits through the structure, bitbake.
> Other notable changes is the Autotooled section re-written.
> Also, SSTATE_DIR variable added to the variables appendix.
> Style tags cleaned up. OProfile cleaned up a bit. Building
> the cross-GDB Package fixed.
>
> 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,
> Scott Rifenbark <scott.m.rifenbark@intel.com>
> ---
>
>
> Scott Rifenbark (16):
> documentation/poky-ref-manual/poky-ref-manual.xml: Updated
> rev-history table
> documentation/poky-ref-manual/development.xml: Edits for Eclipse and
> Anjuta
> documentation/poky-ref-manual/development.xml: Corrected command
> syntax
> documentation/poky-ref-manual/development.xml: OProfileUI section
> updated
> documentation/poky-ref-manual/ref-structure.xml: bitbake section
> updated
> documentation/poky-ref-manual/ref-bitbake.xml: removed 'varname'
> style
> documentation/poky-ref-manual/ref-bitbake.xml: Grammar fix
> documentation/poky-ref-manual/ref-bitbake.xml: type fixed
> document/poky-ref-manual/ref-classes.xml: removed <function> tag
> documentation/poky-ref-manual/ref-classes.xml: Fix to <filename> tag
> documentation/poky-ref-manual/ref-classes.xml: re-write of autotooled
> packages
> documentation/poky-ref-manual/ref-classes.xml: tag updates
> documentation/poky-ref-manual/ref-structure.xml: Edits for Rel 1.0
> documentation/poky-ref-manual/ref-variables.xml: added SSTATE_DIR
> variable
> documentation/poky-ref-manual/ref-bitbake.xml: BitBake parsing
> section update
> documentation/poky-ref-manual/ref-bitbake.xml: style tags updated
>
> documentation/poky-ref-manual/development.xml | 61 +++++++---
> documentation/poky-ref-manual/poky-ref-manual.xml | 4 +-
> documentation/poky-ref-manual/ref-bitbake.xml | 50 ++++----
> documentation/poky-ref-manual/ref-classes.xml | 128 +++++++++------------
> documentation/poky-ref-manual/ref-structure.xml | 108 ++++++++++++++++--
> documentation/poky-ref-manual/ref-variables.xml | 6 +
> 6 files changed, 229 insertions(+), 128 deletions(-)
Merged to master, thanks.
Richard
^ permalink raw reply [flat|nested] 18+ messages in thread