* [PATCH 00/14] Minor documentation updates for 1.1
@ 2011-08-23 15:30 Paul Eggleton
2011-08-23 15:30 ` [PATCH 01/14] documentation: correct QT to Qt Paul Eggleton
` (14 more replies)
0 siblings, 15 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
A number of minor documentation fixes; please review for sanity prior
to merging, in particular I wasn't sure if the document titles were left
blank deliberately.
These changes are against Poky but might need to be merged into yocto-docs
first.
The following changes since commit edd8e1e8b974eb3f0f9f66c2207aadf43612350b:
documentation/adt-manual/adt-command.xml: general edits. (2011-08-20 17:52:00 -0700)
are available in the git repository at:
git://git.pokylinux.org/poky-contrib paule/docs
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=paule/docs
Paul Eggleton (14):
documentation: correct QT to Qt
documentation: update bitbake --help output
README.hardware: typo/capitalisation fixes
documentation: typo, spelling & minor grammar fixes
documentation: POKYMODE/POKYLIBC -> TCMODE/TCLIBC
documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESS
documentation: improve LIC_FILES_CHKSUM documentation
documentation: ensure all examples have LIC_FILES_CHKSUM
documentation: update TERMCMD/TERMCMDRUN documentation
documentation: update for directdisk/live image changes
documentation: update BBFILE_* variable documentation
documentation: set titles for all documents
documentation: update documentation for SRCREV variable
documentation: clarify specifying a specific package with -e
README.hardware | 6 +-
documentation/adt-manual/adt-manual.xml | 2 +-
documentation/bsp-guide/bsp-guide.xml | 2 +-
documentation/bsp-guide/bsp.xml | 4 +-
documentation/dev-manual/dev-manual.xml | 2 +-
documentation/poky-ref-manual/development.xml | 4 +-
.../examples/hello-autotools/hello_2.3.bb | 1 +
.../poky-ref-manual/examples/hello-single/hello.bb | 1 +
.../examples/libxpm/libxpm_3.5.6.bb | 1 +
.../examples/mtd-makefile/mtd-utils_1.0.0.bb | 2 +
documentation/poky-ref-manual/extendpoky.xml | 41 ++++++----
documentation/poky-ref-manual/faq.xml | 10 +-
documentation/poky-ref-manual/introduction.xml | 2 +-
documentation/poky-ref-manual/poky-ref-manual.xml | 2 +-
documentation/poky-ref-manual/ref-bitbake.xml | 34 +++++---
documentation/poky-ref-manual/ref-classes.xml | 8 +-
documentation/poky-ref-manual/ref-features.xml | 2 +-
documentation/poky-ref-manual/ref-images.xml | 64 ++------------
documentation/poky-ref-manual/ref-structure.xml | 10 +-
documentation/poky-ref-manual/ref-variables.xml | 90 +++++++++++++++-----
documentation/poky-ref-manual/ref-varlocality.xml | 4 +-
documentation/poky-ref-manual/resources.xml | 2 +-
documentation/poky-ref-manual/usingpoky.xml | 5 +-
meta/recipes.txt | 2 +-
24 files changed, 160 insertions(+), 141 deletions(-)
--
1.7.4.1
^ permalink raw reply [flat|nested] 16+ messages in thread
* [PATCH 01/14] documentation: correct QT to Qt
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 02/14] documentation: update bitbake --help output Paul Eggleton
` (13 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-structure.xml | 2 +-
meta/recipes.txt | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index 6b5e646..9f8a1c2 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -573,7 +573,7 @@
<title><filename class="directory">meta/recipes-qt/</filename></title>
<para>
- This directory contains all things related to the QT application framework.
+ This directory contains all things related to the Qt application framework.
</para>
</section>
diff --git a/meta/recipes.txt b/meta/recipes.txt
index 51bb746..bf7f19e 100644
--- a/meta/recipes.txt
+++ b/meta/recipes.txt
@@ -8,6 +8,6 @@ recipes-gnome - All things related to the GTK+ application framework
recipes-graphics - X and other graphically related system libraries
recipes-kernel - The kernel and generic applications/libraries with strong kernel dependencies
recipes-multimedia - Codecs and support utilties for audio, images and video
-recipes-qt - All things related to the QT application framework
+recipes-qt - All things related to the Qt application framework
recipes-sato - The Sato demo/reference UI/UX, its associated apps and configuration
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 02/14] documentation: update bitbake --help output
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
2011-08-23 15:30 ` [PATCH 01/14] documentation: correct QT to Qt Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 03/14] README.hardware: typo/capitalisation fixes Paul Eggleton
` (12 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
A number of things have changed since the last time this was updated.
Also replace reference to this being the manpage.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-bitbake.xml | 30 +++++++++++++++---------
1 files changed, 19 insertions(+), 11 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 24e4a06..8fdce3f 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -251,7 +251,7 @@ PREFERRED_PROVIDER_virtual/kernel = "linux-rp"
<title>BitBake Command Line</title>
<para>
- Following is the BitBake manpage:
+ Following is the BitBake help output:
</para>
<screen>
@@ -268,7 +268,8 @@ Options:
-h, --help show this help message and exit
-b BUILDFILE, --buildfile=BUILDFILE
execute the task against this .bb file, rather than a
- package from BBFILES.
+ package from BBFILES. Does not handle any
+ dependencies.
-k, --continue continue as much as possible after an error. While the
target that failed, and those that depend on it,
cannot be remade, the other dependencies of these
@@ -276,8 +277,6 @@ Options:
-a, --tryaltconfigs continue with builds by trying to use alternative
providers where possible.
-f, --force force run of specified cmd, regardless of stamp status
- -i, --interactive drop into the interactive mode also called the BitBake
- shell.
-c CMD, --cmd=CMD Specify task to execute. Note that this only executes
the specified task for the providee and the packages
it depends on, i.e. 'compile' does not implicitly call
@@ -285,26 +284,35 @@ Options:
what you are doing). Depending on the base.bbclass a
listtasks tasks is defined and will show available
tasks
- -r FILE, --read=FILE read the specified file before bitbake.conf
+ -r PREFILE, --read=PREFILE
+ read the specified file before bitbake.conf
+ -R POSTFILE, --postread=POSTFILE
+ read the specified file after bitbake.conf
-v, --verbose output more chit-chat to the terminal
-D, --debug Increase the debug level. You can specify this more
than once.
-n, --dry-run don't execute, just go through the motions
+ -S, --dump-signatures
+ don't execute, just dump out the signature
+ construction information
-p, --parse-only quit after parsing the BB files (developers only)
- -d, --disable-psyco disable using the psyco just-in-time compiler (not
- recommended)
-s, --show-versions show current and preferred versions of all packages
-e, --environment show the global or per-package environment (this is
what used to be bbread)
-g, --graphviz emit the dependency trees of the specified packages in
the dot syntax
- -I IGNORED_DOT_DEPS, --ignore-deps=IGNORED_DOT_DEPS
- Stop processing at the given list of dependencies when
- generating dependency graphs. This can help to make
- the graph more appealing
+ -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED
+ Assume these dependencies don't exist and are already
+ provided (equivalent to ASSUME_PROVIDED). Useful to
+ make dependency graphs more appealing
-l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS
Show debug logging for the specified logging domains
-P, --profile profile the command and print a report
+ -u UI, --ui=UI userinterface to use
+ -t SERVERTYPE, --servertype=SERVERTYPE
+ Choose which server to use, none, process or xmlrpc
+ --revisions-changed Set the exit code depending on whether upstream
+ floating revisions have changed or not
</screen>
</section>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 03/14] README.hardware: typo/capitalisation fixes
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
2011-08-23 15:30 ` [PATCH 01/14] documentation: correct QT to Qt Paul Eggleton
2011-08-23 15:30 ` [PATCH 02/14] documentation: update bitbake --help output Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 04/14] documentation: typo, spelling & minor grammar fixes Paul Eggleton
` (11 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
README.hardware | 6 +++---
1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.hardware b/README.hardware
index d4f7b47..4a0105d 100644
--- a/README.hardware
+++ b/README.hardware
@@ -81,7 +81,7 @@ Depending on the device, it can boot from a traditional hard-disk, a USB device,
or over the network. Writing poky generated images to physical media is
straightforward with a caveat for USB devices. The following examples assume the
target boot device is /dev/sdb, be sure to verify this and use the correct
-device as the following commands are run as root and are not reversable.
+device as the following commands are run as root and are not reversible.
Hard Disk:
1. Build a directdisk image format. This will generate proper partition tables
@@ -155,7 +155,7 @@ the NAND flash. The beagleboard MACHINE is tested on the following platforms:
The Beagleboard C4 has NAND, while the xM does not. For the sake of simplicity,
these instructions assume you have erased the NAND on the C4 so its boot
behavior matches that of the xM. To do this, issue the following commands from
-the u-boot prompt (note that the unlock may be unecessary depending on the
+the u-boot prompt (note that the unlock may be unnecessary depending on the
version of u-boot installed on your board and only one of the erase commands
will succeed):
@@ -168,7 +168,7 @@ documentation at http://www.beagleboard.org.
From a Linux system with access to the image files perform the following steps
as root, replacing mmcblk0* with the SD card device on your machine (such as sdc
-if used via a usb card reader):
+if used via a USB card reader):
1. Partition and format an SD card:
# fdisk -lu /dev/mmcblk0
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 04/14] documentation: typo, spelling & minor grammar fixes
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (2 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 03/14] README.hardware: typo/capitalisation fixes Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 05/14] documentation: POKYMODE/POKYLIBC -> TCMODE/TCLIBC Paul Eggleton
` (10 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/bsp-guide/bsp.xml | 4 ++--
documentation/poky-ref-manual/development.xml | 2 +-
documentation/poky-ref-manual/faq.xml | 10 +++++-----
documentation/poky-ref-manual/introduction.xml | 2 +-
documentation/poky-ref-manual/ref-bitbake.xml | 4 ++--
documentation/poky-ref-manual/ref-classes.xml | 6 +++---
documentation/poky-ref-manual/ref-features.xml | 2 +-
documentation/poky-ref-manual/ref-images.xml | 4 ++--
documentation/poky-ref-manual/ref-structure.xml | 8 ++++----
documentation/poky-ref-manual/ref-variables.xml | 16 ++++++++--------
documentation/poky-ref-manual/resources.xml | 2 +-
documentation/poky-ref-manual/usingpoky.xml | 2 +-
12 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index c7f9f87..be92a47 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -125,7 +125,7 @@ meta-crownbay/conf/layer.conf
meta-crownbay/conf/machine/crownbay.conf
meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
-meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xcorg.conf
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xorg.conf
meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend
meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin/.gitignore
meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin_1.7.99.2.bb
@@ -327,7 +327,7 @@ meta-<bsp_name>/recipes-graphics/*
All files that are needed for the BSP to support a display are kept here.
For example, in the crownbay BSP several display support files exist:
<programlisting>
-meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xcorg.conf
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xorg.conf
meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend
meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin/.gitignore
meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin_1.7.99.2.bb
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index 0639774..c37b481 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -581,7 +581,7 @@
It is worth remembering that inside "devshell" you need to use the full
compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename>
instead of just <filename>gcc</filename>.
- The same applies to other applications such as gcc, bintuils, libtool and so forth.
+ The same applies to other applications such as gcc, binutils, libtool and so forth.
Poky will have setup environmental variables such as CC to assist applications, such as make,
find the correct tools.
</para>
diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml
index 0982d9d..6a1f741 100644
--- a/documentation/poky-ref-manual/faq.xml
+++ b/documentation/poky-ref-manual/faq.xml
@@ -124,7 +124,7 @@
</question>
<answer>
<para>
- The <ulink url='http://vernier.com/labquest/'>Vernier Labquest</ulink> is using Poky (for more about the Labquest see the case study at OpenedHand). There are a number of pre-production devices using Poky and we will announce those as soon as they are released.
+ The <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink> is using Poky (for more about the LabQuest see the case study at OpenedHand). There are a number of pre-production devices using Poky and we will announce those as soon as they are released.
</para>
</answer>
</qandaentry>
@@ -299,7 +299,7 @@
<qandaentry>
<question>
<para>
- I'm using Ubuntu Intrepid and am seeing build failures. Whats wrong?
+ I'm using Ubuntu Intrepid and am seeing build failures. What’s wrong?
</para>
</question>
<answer>
@@ -315,7 +315,7 @@
<qandaentry>
<question>
<para>
- Whats the difference between foo and foo-native?
+ What’s the difference between foo and foo-native?
</para>
</question>
<answer>
@@ -473,7 +473,7 @@
<answer>
<para>
The way Poky obtains source code is highly configurable.
- You can setup Poky to get source code in most environmnents if
+ You can setup Poky to get source code in most environments if
HTTP transport is available.
</para>
<para>
@@ -501,7 +501,7 @@
<para>
These changes cause Poky to intercept GIT, FTP, HTTP, and HTTPS
requests and direct them to the <filename>http://</filename> sources mirror.
- You can use <filename>file://</filename> urls to point to local directories
+ You can use <filename>file://</filename> URLs to point to local directories
or network shares as well.
</para>
<para>
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index 7314b04..1a9b53e 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -103,7 +103,7 @@
(Ubuntu 10.04 or newer) as the host system for Poky, nothing in Poky is
distribution-specific. Consequently, other distributions should work as long
as the appropriate prerequisites are installed. For example, we know of Poky being used
- successfully on Redhat, SUSE, Gentoo and Slackware host systems.
+ successfully on Red Hat, SUSE, Gentoo and Slackware host systems.
For information on what you need to develop images using Yocto Project and Poky,
you should see the Yocto Project Quick Start on the <ulink url="http://www.yoctoproject.org">
Yocto Project website</ulink>.
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 8fdce3f..5dc4369 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -68,7 +68,7 @@
The <filename>base.bbclass</filename> file is always included.
Other classes that are specified in the configuration using the
<glossterm><link linkend='var-INHERIT'>INHERIT</link></glossterm>
- variable are also inculded.
+ variable are also included.
Class files are searched for in a classes subdirectory
under the paths in <filename>BBPATH</filename> in the same way as
configuration files.
@@ -124,7 +124,7 @@
<para>
Sometimes a target might have multiple providers.
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
+ Each machine often selects the best kernel provider by using a line similar to the
following in the machine configuration file:
</para>
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index 8eb94c2..f44b9df 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -93,7 +93,7 @@
<title>Alternatives - <filename>update-alternatives.bbclass</filename></title>
<para>
- Several programs can fulfill the same or similar function and
+ Several programs can fulfil the same or similar function and
be installed with the same name.
For example, the <filename>ar</filename>
command is available from the "busybox", "binutils" and "elfutils" packages.
@@ -218,7 +218,7 @@
<para>
Recipes for Perl modules are simple - usually needs only
pointing to source archive and inheriting of proper bbclass.
- Building is split into two methods dependly on method used by
+ Building is split into two methods depending on the method used by
module authors.
</para>
@@ -362,7 +362,7 @@
Since this isn't possible in general when cross compiling, siteinfo is
used to provide cached test results so these tests can be skipped over but
the correct values used. The <link linkend='structure-meta-site'>meta/site directory</link>
- contains test results sorted into different categories like architecture, endianess and
+ contains test results sorted into different categories like architecture, endianness and
the libc used. Siteinfo provides a list of files containing data relevant to
the current build in the <glossterm><link linkend='var-CONFIG_SITE'>CONFIG_SITE
</link></glossterm> variable which autotools will automatically pick up.
diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml
index b9288bc..e644913 100644
--- a/documentation/poky-ref-manual/ref-features.xml
+++ b/documentation/poky-ref-manual/ref-features.xml
@@ -216,7 +216,7 @@
IMAGE_FEATURES</link></glossterm> variable and the in local.conf and the
<glossterm linkend='var-EXTRA_IMAGE_FEATURES'><link linkend='var-EXTRA_IMAGE_FEATURES'>
EXTRA_IMAGE_FEATURES</link></glossterm> that you typically configure in your image recipes.
- Through these varibales you can add several different
+ Through these variables you can add several different
predefined packages such as development utilities or packages with debug
information needed to investigate application problems or profile applications.
</para>
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml
index 646e441..f8c888d 100644
--- a/documentation/poky-ref-manual/ref-images.xml
+++ b/documentation/poky-ref-manual/ref-images.xml
@@ -131,7 +131,7 @@
<listitem>
<para>
<emphasis><filename>core-image-lsb-sdk-live</filename></emphasis> - A
- <filename>core-image-lsb-sdk</filename> image with the ability to run the image
+<!-- <filename>core-image-lsb-sdk</filename> image with the ability to run the image -->
from a USB device or CD as is.
</para>
</listitem>
@@ -140,7 +140,7 @@
<emphasis><filename>core-image-clutter</filename></emphasis> - An image with
support for
the Open GL-based toolkit Clutter, which enables development of rich and animated
- graphical user interaces.
+ graphical user interfaces.
</para>
</listitem>
<listitem>
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index 9f8a1c2..bdfd1c9 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -195,7 +195,7 @@
<title><filename>build/pseudodone</filename></title>
<para>
- This tag file indicates that the intitial pseudo binar was created.
+ This tag file indicates that the initial pseudo binary was created.
The first time BitBake is invoked this file is built.
</para>
</section>
@@ -484,7 +484,7 @@
Any distribution-specific configuration is controlled from this directory.
Poky only contains the Poky distribution so <filename>poky.conf</filename>
is the main file here.
- This directory includes the versions and SRCDATES for applications that are configured here.
+ This directory includes the versions and SRCDATEs for applications that are configured here.
An example of an alternative configuration is <filename>poky-bleeding.conf</filename>
although this file mainly inherits its configuration from Poky itself.
</para>
@@ -495,7 +495,7 @@
<para>
This directory contains anything linking to specific hardware or hardware configuration information
- such as "uboot" and "grub".
+ such as "u-boot" and "grub".
</para>
</section>
@@ -591,7 +591,7 @@
<para>
This directory contains recipes that used by other recipes, but that are not directly
- included in images (i.e. depenendies of other recipes).
+ included in images (i.e. dependencies of other recipes).
</para>
</section>
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 3601c97..8726b7f 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -73,7 +73,7 @@
<glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
<glossdef>
<para>Identifies layer-specific bbfiles, which contain recipes used by BitBake to build software.
- The Variable is appended with a layer name.</para>
+ The variable is appended with a layer name.</para>
</glossdef>
</glossentry>
@@ -307,7 +307,7 @@
variable generally configured in image recipes.
You can use the EXTRA_IMAGE_FEATURES variable to add more features
in addition to those.
- Here are some exmaples of features you can add:</para>
+ Here are some examples of features you can add:</para>
<literallayout class='monospaced'>
"dbg-pkgs" - Adds -dbg packages for all installed packages
including symbol information for debugging and
@@ -581,7 +581,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
</glossdef>
</glossentry>
- <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMNEDS</glossterm>
+ <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>
<glossdef>
<para>List of packages useful to use device (for example
additional kernel modules)</para>
@@ -625,7 +625,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<glossentry id='var-PACKAGE_DESCRIPTION'><glossterm>PACKAGE_DESCRIPTION</glossterm>
<glossdef>
- <para>Long form description of binary package for packaging sytems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para>
+ <para>Long form description of binary package for packaging systems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para>
</glossdef>
</glossentry>
@@ -640,7 +640,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<glossentry id='var-PACKAGE_SUMMARY'><glossterm>PACKAGE_SUMMARY</glossterm>
<glossdef>
- <para>Short (72 char suggested) Summary of binary package for packaging sytems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para>
+ <para>Short (72 char suggested) Summary of binary package for packaging systems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para>
</glossdef>
</glossentry>
@@ -821,7 +821,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<glossdef>
<para>Speed and device for serial port used to attach
serial console. This is given to kernel as "console"
- param and after boot getty is started on that port
+ parameter and after boot getty is started on that port
so remote login is possible.</para>
</glossdef>
</glossentry>
@@ -945,7 +945,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm>
<glossdef>
<para>Method of handling FPU code. For FPU-less targets
- (most of ARM cpus) it has to be set to "soft" otherwise
+ (most of ARM CPUs) it has to be set to "soft" otherwise
kernel emulation will get used which will result in
performance penalty.</para>
</glossdef>
@@ -963,7 +963,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<glossentry id='var-TERMCMD'><glossterm>TERMCMD</glossterm>
<glossdef>
<para>
- This command is used by bitbake to lauch a terminal window with a
+ This command is used by BitBake to launch a terminal window with a
shell. The shell is unspecified so the user's default shell is used.
By default it is set to <command>gnome-terminal</command> but it can
be any X11 terminal application or terminal multiplexers like screen.
diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml
index fbad871..6df9ed2 100644
--- a/documentation/poky-ref-manual/resources.xml
+++ b/documentation/poky-ref-manual/resources.xml
@@ -72,7 +72,7 @@
<itemizedlist>
<listitem><para>
<ulink url='http://yoctoproject.org'>The Yocto Project website</ulink> - The home site
- for Yocto Project.
+ for the Yocto Project.
</para></listitem>
<!-- <listitem><para>
<ulink url='http://pokylinux.org'>The Poky website</ulink> - The home site
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml
index 6b3289a..0eb9928 100644
--- a/documentation/poky-ref-manual/usingpoky.xml
+++ b/documentation/poky-ref-manual/usingpoky.xml
@@ -332,7 +332,7 @@
<title>Other Tips</title>
<tip>
<para>
- When adding new packages it is worth watching for undesireable items making their way
+ When adding new packages it is worth watching for undesirable items making their way
into compiler command lines.
For example, you do not want references to local system files like
<filename>/usr/lib/</filename> or <filename>/usr/include/</filename>.
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 05/14] documentation: POKYMODE/POKYLIBC -> TCMODE/TCLIBC
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (3 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 04/14] documentation: typo, spelling & minor grammar fixes Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 06/14] documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESS Paul Eggleton
` (9 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
These variables were renamed in the Yocto 1.1 development cycle.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 4 ++--
documentation/poky-ref-manual/ref-varlocality.xml | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 8726b7f..ff82b88 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -720,13 +720,13 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
</glossdef>
</glossentry>
- <glossentry id='var-POKYLIBC'><glossterm>POKYLIBC</glossterm>
+ <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm>
<glossdef>
<para>Libc implementation selector - glibc, eglibc, or uclibc can be selected.</para>
</glossdef>
</glossentry>
- <glossentry id='var-POKYMODE'><glossterm>POKYMODE</glossterm>
+ <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm>
<glossdef>
<para>Toolchain selector. It can be external toolchain
built from Poky or few supported combinations of
diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml
index 21930bf..baff699 100644
--- a/documentation/poky-ref-manual/ref-varlocality.xml
+++ b/documentation/poky-ref-manual/ref-varlocality.xml
@@ -36,10 +36,10 @@
<para><glossterm linkend='var-TARGET_FPU'><link linkend='var-TARGET_FPU'>TARGET_FPU</link></glossterm></para>
</listitem>
<listitem>
- <para><glossterm linkend='var-POKYMODE'><link linkend='var-POKYMODE'>POKYMODE</link></glossterm></para>
+ <para><glossterm linkend='var-TCMODE'><link linkend='var-TCMODE'>TCMODE</link></glossterm></para>
</listitem>
<listitem>
- <para><glossterm linkend='var-POKYLIBC'><link linkend='var-POKYLIBC'>POKYLIBC</link></glossterm></para>
+ <para><glossterm linkend='var-TCLIBC'><link linkend='var-TCLIBC'>TCLIBC</link></glossterm></para>
</listitem>
</itemizedlist>
</section>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 06/14] documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESS
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (4 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 05/14] documentation: POKYMODE/POKYLIBC -> TCMODE/TCLIBC Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 07/14] documentation: improve LIC_FILES_CHKSUM documentation Paul Eggleton
` (8 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
This variable was renamed (to match OE) in the Yocto 1.1 development
cycle.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-classes.xml | 2 +-
documentation/poky-ref-manual/ref-variables.xml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index f44b9df..5812aae 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -369,7 +369,7 @@
</para>
<para>
The class also provides variables like <glossterm><link
- linkend='var-SITEINFO_ENDIANESS'>SITEINFO_ENDIANESS</link></glossterm>
+ linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></glossterm>
and <glossterm><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link>
</glossterm> which can be used elsewhere in the metadata.
</para>
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index ff82b88..cb7a0e4 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -841,7 +841,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
</glossdef>
</glossentry>
- <glossentry id='var-SITEINFO_ENDIANESS'><glossterm>SITEINFO_ENDIANESS</glossterm>
+ <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm>
<glossdef>
<para>
Contains "le" for little-endian or "be" for big-endian depending
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 07/14] documentation: improve LIC_FILES_CHKSUM documentation
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (5 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 06/14] documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESS Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 08/14] documentation: ensure all examples have LIC_FILES_CHKSUM Paul Eggleton
` (7 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
Document that LIC_FILES_CHKSUM is mandatory, when gets validated, and
improve some wording.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/extendpoky.xml | 37 +++++++++++++----------
documentation/poky-ref-manual/ref-variables.xml | 8 ++--
2 files changed, 25 insertions(+), 20 deletions(-)
diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml
index e9835f2..9035842 100644
--- a/documentation/poky-ref-manual/extendpoky.xml
+++ b/documentation/poky-ref-manual/extendpoky.xml
@@ -901,25 +901,25 @@ SRC_URI += "file://NAME-OF-PATCH.patch"
</section>
<section id="usingpoky-configuring-LIC_FILES_CHKSUM">
- <title>Track License Change</title>
+ <title>Tracking License Changes</title>
<para>
- The license of an upstream project might change in the future.
- Poky uses the <glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm> variable
- to track license changes.
+ The license of an upstream project might change in the future. In order to prevent these changes
+ going unnoticed, Poky provides a <glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm>
+ variable to track changes to the license text. The checksums are validated at the end of the configure
+ step, and if the checksums do not match, the build will fail.
</para>
<section id="usingpoky-specifying-LIC_FILES_CHKSUM">
<title>Specifying the LIC_FILES_CHKSUM Variable</title>
<para>
The <glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm>
- variable contains checksums of the license text in the recipe source code.
- Poky uses this to track changes in the license text of the source code files.
- Following is an example of LIC_FILES_CHKSUM:
+ variable contains checksums of the license text in the source code for the recipe.
+ Following is an example of how to specify LIC_FILES_CHKSUM:
</para>
<programlisting>
-LIC_FILES_CHKSUM = "file://COPYING; md5=xxxx \
- file://licfile1.txt; beginline=5; endline=29;md5=yyyy \
- file://licfile2.txt; endline=50;md5=zzzz \
+LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \
+ file://licfile1.txt;beginline=5;endline=29;md5=yyyy \
+ file://licfile2.txt;endline=50;md5=zzzz \
..."
</programlisting>
<para>
@@ -942,6 +942,10 @@ LIC_FILES_CHKSUM = "file://../license.html;md5=5c94767cedb5d6987c902ac850ded2c6"
<glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm>, which is the parent
of <glossterm><link linkend='var-S'>S</link></glossterm>.
</para>
+ <para>
+ Note that this variable is mandatory for all recipes, unless the LICENSE variable is set to
+ "CLOSED".
+ </para>
</section>
<section id="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax">
@@ -949,8 +953,9 @@ LIC_FILES_CHKSUM = "file://../license.html;md5=5c94767cedb5d6987c902ac850ded2c6"
<para>
As mentioned in the previous section the LIC_FILES_CHKSUM variable lists all the
important files that contain the license text for the source code.
- Using this variable you can specify the line on which the license text starts and ends
- by supplying "beginline" and "endline" parameters.
+ It is possible to specify a checksum for an entire file, or a specified section of a
+ file (specified by beginning and ending line numbers). The latter is useful for source
+ files with license notice header, README documents, etc.
If you do not use the "beginline" parameter then it is assumed that the text begins on the
first line of the file.
Similarly, if you do not use the "endline" parameter it is assumed that the license text
@@ -959,18 +964,18 @@ LIC_FILES_CHKSUM = "file://../license.html;md5=5c94767cedb5d6987c902ac850ded2c6"
<para>
The "md5" parameter stores the md5 checksum of the license text.
If the license text changes in any way as compared to this parameter
- then a mis-match occurs.
+ then a mismatch occurs.
This mismatch triggers a build failure and notifies the developer.
Notification allows the developer to review and address the license text changes.
- Also note that if a mis-match occurs during the build, the correct md5
- checksum is placed in the build log and can be easily copied to a .bb file.
+ Also note that if a mismatch occurs during the build, the correct md5
+ checksum is placed in the build log and can be easily copied to the recipe.
</para>
<para>
There is no limit to how many files you can specify using the LIC_FILES_CHKSUM variable.
Generally, however, every project requires a few specifications for license tracking.
Many projects have a "COPYING" file that stores the license information for all the source
code files.
- This practice allow you to just track the "COPYING" file as long as it is kept up to date.
+ This practice allows you to just track the "COPYING" file as long as it is kept up to date.
</para>
<tip>
If you specify an empty or invalid "md5" parameter, BitBake returns an md5 mis-match
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index cb7a0e4..095ccf6 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -539,11 +539,11 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<para>Checksums of the license text in the recipe source code.
</para>
<para>This variable tracks changes in license text of the source
- code files. If the license text is changed, it will trigger the build
+ code files. If the license text is changed, it will trigger a build
failure, which gives developer an opportunity to review any
- license change</para>
- <para> This is an optional variable now, and the plan is to make
- it a required variable in the future </para>
+ license change.</para>
+ <para> This variable must be defined for all recipes (unless LICENSE
+ is set to "CLOSED")</para>
<para>See "meta/package/zlib/zlib_${PV}.bb" file for an example</para>
<para>More information in <link
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 08/14] documentation: ensure all examples have LIC_FILES_CHKSUM
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (6 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 07/14] documentation: improve LIC_FILES_CHKSUM documentation Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 09/14] documentation: update TERMCMD/TERMCMDRUN documentation Paul Eggleton
` (6 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
We really need to have LIC_FILES_CHKSUM in all of our example recipes,
because it is now mandatory.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
.../examples/hello-autotools/hello_2.3.bb | 1 +
.../poky-ref-manual/examples/hello-single/hello.bb | 1 +
.../examples/libxpm/libxpm_3.5.6.bb | 1 +
.../examples/mtd-makefile/mtd-utils_1.0.0.bb | 2 ++
documentation/poky-ref-manual/extendpoky.xml | 4 ++++
5 files changed, 9 insertions(+), 0 deletions(-)
diff --git a/documentation/poky-ref-manual/examples/hello-autotools/hello_2.3.bb b/documentation/poky-ref-manual/examples/hello-autotools/hello_2.3.bb
index 5c5332f..5dfb0b3 100644
--- a/documentation/poky-ref-manual/examples/hello-autotools/hello_2.3.bb
+++ b/documentation/poky-ref-manual/examples/hello-autotools/hello_2.3.bb
@@ -1,6 +1,7 @@
DESCRIPTION = "GNU Helloworld application"
SECTION = "examples"
LICENSE = "GPLv3"
+LIC_FILES_CHKSUM = "file://COPYING;md5=adefda309052235aa5d1e99ce7557010"
SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.bz2"
diff --git a/documentation/poky-ref-manual/examples/hello-single/hello.bb b/documentation/poky-ref-manual/examples/hello-single/hello.bb
index d815b1e..0812743 100644
--- a/documentation/poky-ref-manual/examples/hello-single/hello.bb
+++ b/documentation/poky-ref-manual/examples/hello-single/hello.bb
@@ -1,6 +1,7 @@
DESCRIPTION = "Simple helloworld application"
SECTION = "examples"
LICENSE = "MIT"
+LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
SRC_URI = "file://helloworld.c"
diff --git a/documentation/poky-ref-manual/examples/libxpm/libxpm_3.5.6.bb b/documentation/poky-ref-manual/examples/libxpm/libxpm_3.5.6.bb
index 2710189..b58d4d7 100644
--- a/documentation/poky-ref-manual/examples/libxpm/libxpm_3.5.6.bb
+++ b/documentation/poky-ref-manual/examples/libxpm/libxpm_3.5.6.bb
@@ -2,6 +2,7 @@ require xorg-lib-common.inc
DESCRIPTION = "X11 Pixmap library"
LICENSE = "X-BSD"
+LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5"
DEPENDS += "libxext"
PR = "r2"
PE = "1"
diff --git a/documentation/poky-ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb b/documentation/poky-ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
index b21dc65..5d05a43 100644
--- a/documentation/poky-ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
+++ b/documentation/poky-ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
@@ -3,6 +3,8 @@ SECTION = "base"
DEPENDS = "zlib"
HOMEPAGE = "http://www.linux-mtd.infradead.org/"
LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
+ file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"
SRC_URI = "ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-${PV}.tar.gz"
diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml
index 9035842..02145e0 100644
--- a/documentation/poky-ref-manual/extendpoky.xml
+++ b/documentation/poky-ref-manual/extendpoky.xml
@@ -52,6 +52,7 @@
DESCRIPTION = "Simple helloworld application"
SECTION = "examples"
LICENSE = "MIT"
+LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
PR = "r0"
SRC_URI = "file://helloworld.c"
@@ -141,6 +142,8 @@ SECTION = "base"
DEPENDS = "zlib lzo e2fsprogs util-linux"
HOMEPAGE = "http://www.linux-mtd.infradead.org/"
LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
+ file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"
SRC_URI = "git://git.infradead.org/mtd-utils.git;protocol=git;tag=v${PV}"
@@ -179,6 +182,7 @@ require xorg-lib-common.inc
DESCRIPTION = "X11 Pixmap library"
LICENSE = "X-BSD"
+LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5"
DEPENDS += "libxext libsm libxt"
PR = "r3"
PE = "1"
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 09/14] documentation: update TERMCMD/TERMCMDRUN documentation
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (7 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 08/14] documentation: ensure all examples have LIC_FILES_CHKSUM Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 10/14] documentation: update for directdisk/live image changes Paul Eggleton
` (5 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
* xterm is now the default
* Konsole from KDE 4.x will no longer work due to changes in behaviour
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/development.xml | 2 +-
documentation/poky-ref-manual/ref-variables.xml | 10 +++++++++-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index c37b481..c3aeeb8 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -561,7 +561,7 @@
</para>
<para>
- The default shell used by "devshell" is the gnome-terminal.
+ The default shell used by "devshell" is xterm.
You can use other forms of terminal can by setting the <glossterm>
<link linkend='var-TERMCMD'>TERMCMD</link></glossterm> and <glossterm>
<link linkend='var-TERMCMDRUN'>TERMCMDRUN</link></glossterm> variables
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 095ccf6..eab3bda 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -965,9 +965,17 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<para>
This command is used by BitBake to launch a terminal window with a
shell. The shell is unspecified so the user's default shell is used.
- By default it is set to <command>gnome-terminal</command> but it can
+ By default it is set to <command>xterm</command> but it can
be any X11 terminal application or terminal multiplexers like screen.
</para>
+ <para>
+ NOTE: whilst KONSOLE_TERMCMD and KONSOLE_TERMCMDRUN are provided
+ and will work with KDE's Konsole terminal application Konsole from KDE 3,
+ Konsole in KDE 4.0 and later will no longer work here due to the fact
+ that it now launches in the background by default, and it is not practically
+ possible to wait until it has terminated. It is hoped that this can be fixed
+ in a future version.
+ </para>
</glossdef>
</glossentry>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 10/14] documentation: update for directdisk/live image changes
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (8 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 09/14] documentation: update TERMCMD/TERMCMDRUN documentation Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 11/14] documentation: update BBFILE_* variable documentation Paul Eggleton
` (4 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
-live and -directdisk image have been removed; add a tip about using the
live option in IMAGE_FSTYPES to build any image as a live image.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-images.xml | 62 +++-----------------------
1 files changed, 7 insertions(+), 55 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml
index f8c888d..3ace353 100644
--- a/documentation/poky-ref-manual/ref-images.xml
+++ b/documentation/poky-ref-manual/ref-images.xml
@@ -64,13 +64,6 @@
</listitem>
<listitem>
<para>
- <emphasis><filename>core-image-minimal-directdisk</filename></emphasis> – A
- <filename>core-image-minimal</filename> image that you can
- copy directly to the disk of the target device.
- </para>
- </listitem>
- <listitem>
- <para>
<emphasis><filename>core-image-minimal-initramfs</filename></emphasis> –
A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel,
@@ -79,13 +72,6 @@
</listitem>
<listitem>
<para>
- <emphasis><filename>core-image-minimal-live</filename></emphasis> – A
- <filename>core-image-minimal</filename> image you can run from a
- USB device or CD as is.
- </para>
- </listitem>
- <listitem>
- <para>
<emphasis><filename>core-image-minimal-mtdutils</filename></emphasis> – A
<filename>core-image-minimal</filename> image that has support
for the Minimal MTD Utilities, which let the user interact with the
@@ -114,12 +100,6 @@
</listitem>
<listitem>
<para>
- <emphasis><filename>core-image-lsb-live</filename></emphasis> - A
- <filename>core-image-lsb</filename> image that you run from a USB device or CD as is.
- </para>
- </listitem>
- <listitem>
- <para>
<emphasis><filename>core-image-lsb-sdk</filename></emphasis> - A
<filename>core-image-lsb</filename> that includes everything in meta-toolchain
but also includes development
@@ -130,13 +110,6 @@
</listitem>
<listitem>
<para>
- <emphasis><filename>core-image-lsb-sdk-live</filename></emphasis> - A
-<!-- <filename>core-image-lsb-sdk</filename> image with the ability to run the image -->
- from a USB device or CD as is.
- </para>
- </listitem>
- <listitem>
- <para>
<emphasis><filename>core-image-clutter</filename></emphasis> - An image with
support for
the Open GL-based toolkit Clutter, which enables development of rich and animated
@@ -163,20 +136,6 @@
</listitem>
<listitem>
<para>
- <emphasis><filename>core-image-sato-directdisk</filename></emphasis> - A
- <filename>core-image-sato</filename> image that can be copied directly to the
- disk of the target device.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis><filename>core-image-sato-live</filename></emphasis> - A
- <filename>core-image-sato</filename> image with the ability to run
- from a USB device or CD as is.
- </para>
- </listitem>
- <listitem>
- <para>
<emphasis><filename>core-image-sato-sdk</filename></emphasis> - A
<filename>core-image-sato</filename> image that includes everything in meta-toolchain.
The image also includes development headers and libraries to form a complete standalone SDK.
@@ -184,21 +143,14 @@
External Development Using the Poky SDK</link> section for more information..
</para>
</listitem>
- <listitem>
- <para>
- <emphasis><filename>core-image-sato-sdk-directdisk</filename></emphasis> - A
- <filename>core-image-sato-sdk</filename> image that can be copied directly to the
- disk of the target device.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis><filename>core-image-sato-sdk-live</filename></emphasis> - A
- <filename>core-image-sato-sdk</filename> image that you can run
- from a USB device or CD as is.
- </para>
- </listitem>
</itemizedlist>
+
+ <tip>
+ From Yocto release 1.1 onwards, -live and -directdisk images have been replaced by a "live"
+ option in IMAGE_FSTYPES that will work with any image. To build a live image, simply add
+ "live" to IMAGE_FSTYPES within local.conf or whereever appropriate and then build the desired
+ image as normal.
+ </tip>
</appendix>
<!--
vim: expandtab tw=80 ts=4
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 11/14] documentation: update BBFILE_* variable documentation
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (9 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 10/14] documentation: update for directdisk/live image changes Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 12/14] documentation: set titles for all documents Paul Eggleton
` (3 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
* Add documentation of LAYERVERSION, LAYERDEPENDS and new layer priority
behaviour
* Improve some wording
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 46 +++++++++++++++++++---
1 files changed, 39 insertions(+), 7 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index eab3bda..b6bf97a 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -72,22 +72,24 @@
<glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
<glossdef>
- <para>Identifies layer-specific bbfiles, which contain recipes used by BitBake to build software.
- The variable is appended with a layer name.</para>
+ <para>Lists the names of configured layers. These names are used to find the other BBFILE_*
+ variables. Typically each layer will append its name to this variable in its
+ <filename>conf/layer.conf</filename> file.
+ </para>
</glossdef>
</glossentry>
<glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm>
<glossdef>
<para>Variable that expands to match files from BBFILES in a particular layer. BBFILE_PATTERN
- is used in the <filename>conf/layer.conf</filename> file and must contain the name of the
- specific layer (e.g. BBFILE_PATTERN_emenlow).</para>
+ is used in the <filename>conf/layer.conf</filename> file and must be suffixed with the name
+ of the specific layer (e.g. BBFILE_PATTERN_emenlow).</para>
</glossdef>
</glossentry>
<glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm>
<glossdef>
- <para>Assigns different priorities to recipe files in different layers.</para>
+ <para>Assigns the priority for recipe files in each layer.</para>
<para>This variable is useful in situations where the same package appears in
more than one layer.
Setting BBFILE_PRIORITY allows you to prioritize a
@@ -102,13 +104,20 @@
precedence.
For example, the value 6 has a higher precedence than the
value 5.
- By default, the BBFILE_PRIORITY variable is set to the value 5.</para>
+ If not specified, the BBFILE_PRIORITY variable is set based on layer
+ dependencies (see LAYERDEPENDS below). Tdefault priority if unspecified
+ for a layer with no dependencies is the lowest defined priority + 1
+ (or 1 if no priorities are defined).</para>
+ <tip>
+ You can use the command "bitbake-layers show_layers" to list
+ all configured layers along with their priorities.
+ </tip>
</glossdef>
</glossentry>
<glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
<glossdef>
- <para>List of recipes used by BitBake to build software</para>
+ <para>List of recipe files used by BitBake to build software</para>
</glossdef>
</glossentry>
@@ -520,6 +529,19 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<glossdiv id='var-glossary-l'><title>L</title>
+ <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm>
+ <glossdef>
+ <para>Lists the layers that this recipe depends upon, separated by spaces.
+ Optionally a specific layer version may be specified for a dependency
+ by adding it to the end of the layer name with a colon, e.g. "anotherlayer:3"
+ (to be compared against LAYERVERSION_anotherlayer in this example).
+ An error will be produced if any dependency is missing or
+ the version numbers do not match exactly (if specified).
+ This variable is used in the <filename>conf/layer.conf</filename> file
+ and must be suffixed with the name of the specific layer (e.g.
+ LAYERDEPENDS_mylayer).</para>
+ </glossdef>
+ </glossentry>
<glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
<glossdef>
<para>When used inside a layer.conf gives the path of the
@@ -529,6 +551,16 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
giving the wrong value.</para>
</glossdef>
</glossentry>
+ <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
+ <glossdef>
+ <para>Optionally specifies the version of a layer as a single number.
+ This may be used within LAYERDEPENDS for another layer in order to
+ depend on a specific version of the layer.
+ This variable is used in the <filename>conf/layer.conf</filename> file
+ and must be suffixed with the name of the specific layer (e.g.
+ LAYERVERSION_mylayer).</para>
+ </glossdef>
+ </glossentry>
<glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
<glossdef>
<para>List of package source licenses.</para>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 12/14] documentation: set titles for all documents
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (10 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 11/14] documentation: update BBFILE_* variable documentation Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 13/14] documentation: update documentation for SRCREV variable Paul Eggleton
` (2 subsequent siblings)
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
These documents do not have titles when showing up on the website; set
the title tag value so that they do.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/adt-manual/adt-manual.xml | 2 +-
documentation/bsp-guide/bsp-guide.xml | 2 +-
documentation/dev-manual/dev-manual.xml | 2 +-
documentation/poky-ref-manual/poky-ref-manual.xml | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml
index 34ccf6f..7fef091 100644
--- a/documentation/adt-manual/adt-manual.xml
+++ b/documentation/adt-manual/adt-manual.xml
@@ -15,7 +15,7 @@
</imageobject>
</mediaobject>
- <title></title>
+ <title>Yocto Application Development Tookit (ADT) User's Guide</title>
<authorgroup>
<author>
diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml
index 75fa7fe..08feb5d 100644
--- a/documentation/bsp-guide/bsp-guide.xml
+++ b/documentation/bsp-guide/bsp-guide.xml
@@ -15,7 +15,7 @@
</imageobject>
</mediaobject>
- <title></title>
+ <title>Yocto Board Support Package (BSP) Development Guide</title>
<authorgroup>
<author>
diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml
index baddc1c..1be8e20 100644
--- a/documentation/dev-manual/dev-manual.xml
+++ b/documentation/dev-manual/dev-manual.xml
@@ -15,7 +15,7 @@
</imageobject>
</mediaobject>
- <title></title>
+ <title>Yocto Project Development Manual</title>
<authorgroup>
<author>
diff --git a/documentation/poky-ref-manual/poky-ref-manual.xml b/documentation/poky-ref-manual/poky-ref-manual.xml
index a954367..8f861a7 100644
--- a/documentation/poky-ref-manual/poky-ref-manual.xml
+++ b/documentation/poky-ref-manual/poky-ref-manual.xml
@@ -15,7 +15,7 @@
</imageobject>
</mediaobject>
- <title></title>
+ <title>Poky Reference Manual</title>
<authorgroup>
<author>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 13/14] documentation: update documentation for SRCREV variable
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (11 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 12/14] documentation: set titles for all documents Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 15:30 ` [PATCH 14/14] documentation: clarify specifying a specific package with -e Paul Eggleton
2011-08-23 23:10 ` [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
* Add note about specifying a full revision ID to prevent querying the
remote server on every parse
* Mercurial also supports this variable
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 6 +++++-
1 files changed, 5 insertions(+), 1 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index b6bf97a..7c68023 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -923,7 +923,11 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
<glossdef>
<para>
Revision of source code used to build package (Subversion,
- GIT, Bazaar only).
+ Git, Mercurial, Bazaar only). Note that if you wish to build
+ a fixed revision and you wish to avoid performing a query on
+ the remote repository every time BitBake parses your recipe,
+ you should specify a SRCREV that is a full revision identifier
+ (and not just a tag).
</para>
</glossdef>
</glossentry>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH 14/14] documentation: clarify specifying a specific package with -e
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (12 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 13/14] documentation: update documentation for SRCREV variable Paul Eggleton
@ 2011-08-23 15:30 ` Paul Eggleton
2011-08-23 23:10 ` [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 15:30 UTC (permalink / raw)
To: yocto
The -b option is not required to show the environment used to build a
specific package; usually the best practice is to specify the package
name alone.
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
documentation/poky-ref-manual/usingpoky.xml | 3 ++-
1 files changed, 2 insertions(+), 1 deletions(-)
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml
index 0eb9928..91ec14b 100644
--- a/documentation/poky-ref-manual/usingpoky.xml
+++ b/documentation/poky-ref-manual/usingpoky.xml
@@ -324,7 +324,8 @@
<para>
The "-e" option dumps the resulting environment for
either the configuration (no package specified) or for a
- specific package when specified with the "-b" option.
+ specific package when specified; or "-b recipename" to
+ show the environment from parsing a single recipe file only.
</para>
</section>
--
1.7.4.1
^ permalink raw reply related [flat|nested] 16+ messages in thread
* Re: [PATCH 00/14] Minor documentation updates for 1.1
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
` (13 preceding siblings ...)
2011-08-23 15:30 ` [PATCH 14/14] documentation: clarify specifying a specific package with -e Paul Eggleton
@ 2011-08-23 23:10 ` Paul Eggleton
14 siblings, 0 replies; 16+ messages in thread
From: Paul Eggleton @ 2011-08-23 23:10 UTC (permalink / raw)
To: yocto
On Tuesday 23 August 2011 16:30:33 Paul Eggleton wrote:
> A number of minor documentation fixes; please review for sanity prior
> to merging, in particular I wasn't sure if the document titles were left
> blank deliberately.
>
> These changes are against Poky but might need to be merged into yocto-docs
> first.
Have spoken to Scott R, seems he's been working on the Poky reference manual
so I will need to rebase once he's pushed his changes. Feel free to review but
do not merge this set.
Thanks,
Paul
--
Paul Eggleton
Intel Open Source Technology Centre
^ permalink raw reply [flat|nested] 16+ messages in thread
end of thread, other threads:[~2011-08-23 23:10 UTC | newest]
Thread overview: 16+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-08-23 15:30 [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
2011-08-23 15:30 ` [PATCH 01/14] documentation: correct QT to Qt Paul Eggleton
2011-08-23 15:30 ` [PATCH 02/14] documentation: update bitbake --help output Paul Eggleton
2011-08-23 15:30 ` [PATCH 03/14] README.hardware: typo/capitalisation fixes Paul Eggleton
2011-08-23 15:30 ` [PATCH 04/14] documentation: typo, spelling & minor grammar fixes Paul Eggleton
2011-08-23 15:30 ` [PATCH 05/14] documentation: POKYMODE/POKYLIBC -> TCMODE/TCLIBC Paul Eggleton
2011-08-23 15:30 ` [PATCH 06/14] documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESS Paul Eggleton
2011-08-23 15:30 ` [PATCH 07/14] documentation: improve LIC_FILES_CHKSUM documentation Paul Eggleton
2011-08-23 15:30 ` [PATCH 08/14] documentation: ensure all examples have LIC_FILES_CHKSUM Paul Eggleton
2011-08-23 15:30 ` [PATCH 09/14] documentation: update TERMCMD/TERMCMDRUN documentation Paul Eggleton
2011-08-23 15:30 ` [PATCH 10/14] documentation: update for directdisk/live image changes Paul Eggleton
2011-08-23 15:30 ` [PATCH 11/14] documentation: update BBFILE_* variable documentation Paul Eggleton
2011-08-23 15:30 ` [PATCH 12/14] documentation: set titles for all documents Paul Eggleton
2011-08-23 15:30 ` [PATCH 13/14] documentation: update documentation for SRCREV variable Paul Eggleton
2011-08-23 15:30 ` [PATCH 14/14] documentation: clarify specifying a specific package with -e Paul Eggleton
2011-08-23 23:10 ` [PATCH 00/14] Minor documentation updates for 1.1 Paul Eggleton
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.