sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual, profile-manual: changed "plugin" to "plug-in" 

Changed all these occurrances throughout the manual set so
they are consistent.  The only ones left are now in pathnames
or UI things where they need to stay that way.

(From yocto-docs rev: 1b77f34b7b6983f7d7e680cd9fd6a714c00ba8f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-09-19 12:05:15 -07:00 committed by Richard Purdie
parent d3bf6bd677
commit 9fbaa9b9ec
2 changed files with 75 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

146
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -235,10 +235,10 @@
<para> <para>
To create layers that are easier to maintain and that will To create layers that are easier to maintain and that will
not impact builds for other machines, you should consider the not impact builds for other machines, you should consider the
information in the following sections. information in the following sections.
</para> </para>
<section id='avoid-overlaying-entire-recipes'> <section id='avoid-overlaying-entire-recipes'>
<title>Avoid "Overlaying" Entire Recipes</title> <title>Avoid "Overlaying" Entire Recipes</title>
@ -270,19 +270,19 @@
the layer to which it originally belongs. the layer to which it originally belongs.
If this is the case, you need to address that deficiency If this is the case, you need to address that deficiency
instead of overlaying the include file. instead of overlaying the include file.
For example, consider how support plugins for the Qt 4 For example, consider how support plug-ins for the Qt 4
database are configured. database are configured.
The Source Directory does not have MySQL or PostgreSQL. The Source Directory does not have MySQL or PostgreSQL.
However, OpenEmbedded's layer <filename>meta-oe</filename> However, OpenEmbedded's layer <filename>meta-oe</filename>
does. does.
Consequently, <filename>meta-oe</filename> uses Consequently, <filename>meta-oe</filename> uses
<filename>.bbappend</filename> files to modify the <filename>.bbappend</filename> files to modify the
<filename>QT_SQL_DRIVER_FLAGS</filename> variable to <filename>QT_SQL_DRIVER_FLAGS</filename> variable to
enable the appropriate plugins. enable the appropriate plug-ins.
This variable was added to the <filename>qt4.inc</filename> This variable was added to the <filename>qt4.inc</filename>
include file in the Source Directory specifically to allow include file in the Source Directory specifically to allow
the <filename>meta-oe</filename> layer to be able to control the <filename>meta-oe</filename> layer to be able to control
which plugins are built. which plug-ins are built.
</para> </para>
</section> </section>
@ -290,105 +290,105 @@
<title>Structure Your Layers</title> <title>Structure Your Layers</title>
<para> <para>
Proper use of overrides within append files and placement Proper use of overrides within append files and placement
of machine-specific files within your layer can ensure that of machine-specific files within your layer can ensure that
a build is not using the wrong Metadata and negatively a build is not using the wrong Metadata and negatively
impacting a build for a different machine. impacting a build for a different machine.
Following are some examples: Following are some examples:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Modifying Variables to support <listitem><para><emphasis>Modifying Variables to support
a different machine:</emphasis> a different machine:</emphasis>
Suppose you have a layer named Suppose you have a layer named
<filename>meta-one</filename> that adds support <filename>meta-one</filename> that adds support
for building machine "one". for building machine "one".
To do so, you use an append file named To do so, you use an append file named
<filename>base-files.bbappend</filename> and <filename>base-files.bbappend</filename> and
create a dependency on "foo" by altering the create a dependency on "foo" by altering the
<ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>
variable: variable:
<literallayout class='monospaced'> <literallayout class='monospaced'>
DEPENDS = "foo" DEPENDS = "foo"
</literallayout> </literallayout>
The dependency is created during any build that The dependency is created during any build that
includes the layer includes the layer
<filename>meta-one</filename>. <filename>meta-one</filename>.
However, you might not want this dependency However, you might not want this dependency
for all machines. for all machines.
For example, suppose you are building for For example, suppose you are building for
machine "two" but your machine "two" but your
<filename>bblayers.conf</filename> file has the <filename>bblayers.conf</filename> file has the
<filename>meta-one</filename> layer included. <filename>meta-one</filename> layer included.
During the build, the During the build, the
<filename>base-files</filename> for machine <filename>base-files</filename> for machine
"two" will also have the dependency on "two" will also have the dependency on
<filename>foo</filename>.</para> <filename>foo</filename>.</para>
<para>To make sure your changes apply only when <para>To make sure your changes apply only when
building machine "one", use a machine override building machine "one", use a machine override
with the <filename>DEPENDS</filename> statement: with the <filename>DEPENDS</filename> statement:
<literallayout class='monospaced'> <literallayout class='monospaced'>
DEPENDS_one = "foo" DEPENDS_one = "foo"
</literallayout> </literallayout>
You should follow the same strategy when using You should follow the same strategy when using
<filename>_append</filename> and <filename>_append</filename> and
<filename>_prepend</filename> operations: <filename>_prepend</filename> operations:
<literallayout class='monospaced'> <literallayout class='monospaced'>
DEPENDS_append_one = " foo" DEPENDS_append_one = " foo"
DEPENDS_prepend_one = "foo " DEPENDS_prepend_one = "foo "
</literallayout> </literallayout>
<note> <note>
Avoiding "+=" and "=+" and using Avoiding "+=" and "=+" and using
machine-specific machine-specific
<filename>_append</filename> <filename>_append</filename>
and <filename>_prepend</filename> operations and <filename>_prepend</filename> operations
is recommended as well. is recommended as well.
</note></para></listitem> </note></para></listitem>
<listitem><para><emphasis>Place Machine-Specific Files <listitem><para><emphasis>Place Machine-Specific Files
in Machine-Specific Locations:</emphasis> in Machine-Specific Locations:</emphasis>
When you have a base recipe, such as When you have a base recipe, such as
<filename>base-files.bb</filename>, that <filename>base-files.bb</filename>, that
contains a contains a
<ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
statement to a file, you can use an append file statement to a file, you can use an append file
to cause the build to use your own version of to cause the build to use your own version of
the file. the file.
For example, an append file in your layer at For example, an append file in your layer at
<filename>/meta-one/recipes-core/base-files/base-files.bbappend</filename> <filename>/meta-one/recipes-core/base-files/base-files.bbappend</filename>
could extend could extend
<ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink>
using using
<ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
as follows: as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
FILESEXTRAPATHS_prepend := "${THISDIR}/${BPN}:" FILESEXTRAPATHS_prepend := "${THISDIR}/${BPN}:"
</literallayout> </literallayout>
The build for machine "one" will pick up your The build for machine "one" will pick up your
machine-specific file as long as you have the machine-specific file as long as you have the
file in file in
<filename>/meta-one/recipes-core/base-files/base-files/</filename>. <filename>/meta-one/recipes-core/base-files/base-files/</filename>.
However, if you are building for a different However, if you are building for a different
machine and the machine and the
<filename>bblayers.conf</filename> file includes <filename>bblayers.conf</filename> file includes
the <filename>meta-one</filename> layer and the <filename>meta-one</filename> layer and
the location of your machine-specific file is the location of your machine-specific file is
the first location where that file is found the first location where that file is found
according to <filename>FILESPATH</filename>, according to <filename>FILESPATH</filename>,
builds for all machines will also use that builds for all machines will also use that
machine-specific file.</para> machine-specific file.</para>
<para>You can make sure that a machine-specific <para>You can make sure that a machine-specific
file is used for a particular machine by putting file is used for a particular machine by putting
the file in a subdirectory specific to the the file in a subdirectory specific to the
machine. machine.
For example, rather than placing the file in For example, rather than placing the file in
<filename>/meta-one/recipes-core/base-files/base-files/</filename> <filename>/meta-one/recipes-core/base-files/base-files/</filename>
as shown above, put it in as shown above, put it in
<filename>/meta-one/recipes-core/base-files/base-files/one/</filename>. <filename>/meta-one/recipes-core/base-files/base-files/one/</filename>.
Not only does this make sure the file is used Not only does this make sure the file is used
only when building for machine "one" but the only when building for machine "one" but the
build process locates the file more quickly.</para> build process locates the file more quickly.</para>
<para>In summary, you need to place all files <para>In summary, you need to place all files
referenced from <filename>SRC_URI</filename> referenced from <filename>SRC_URI</filename>
in a machine-specific subdirectory within the in a machine-specific subdirectory within the
layer in order to restrict those files to layer in order to restrict those files to
machine-specific builds.</para></listitem> machine-specific builds.</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@ -2596,8 +2596,8 @@
If you have distro-specific configuration files If you have distro-specific configuration files
that are included by an existing recipe, you should that are included by an existing recipe, you should
add a <filename>.bbappend</filename> for those. add a <filename>.bbappend</filename> for those.
For general information and recommendations For general information and recommendations
on how to add recipes to your layer, see the on how to add recipes to your layer, see the
"<link linkend='creating-your-own-layer'>Creating Your Own Layer</link>" "<link linkend='creating-your-own-layer'>Creating Your Own Layer</link>"
and and
"<link linkend='best-practices-to-follow-when-creating-layers'>Best Practices to Follow When Creating Layers</link>" "<link linkend='best-practices-to-follow-when-creating-layers'>Best Practices to Follow When Creating Layers</link>"
@ -3076,7 +3076,7 @@
<title>Excluding Packages from an Image</title> <title>Excluding Packages from an Image</title>
<para> <para>
You might find it necessary to prevent specific packages You might find it necessary to prevent specific packages
from being installed into an image. from being installed into an image.
If so, you can use several variables to direct the build If so, you can use several variables to direct the build
system to essentially ignore installing recommended packages system to essentially ignore installing recommended packages
@ -3084,31 +3084,31 @@
</para> </para>
<para> <para>
The following list introduces variables you can use to The following list introduces variables you can use to
prevent packages from being installed into your image. prevent packages from being installed into your image.
Each of these variables only works with IPK and RPM Each of these variables only works with IPK and RPM
package types. package types.
Support for Debian packages does not exist. Support for Debian packages does not exist.
Also, you can use these variables from your Also, you can use these variables from your
<filename>local.conf</filename> file or attach them to a <filename>local.conf</filename> file or attach them to a
specific image recipe by using a recipe name override. specific image recipe by using a recipe name override.
For more detail on the variables, see the descriptions in the For more detail on the variables, see the descriptions in the
Yocto Project Reference Manual's glossary chapter. Yocto Project Reference Manual's glossary chapter.
<itemizedlist> <itemizedlist>
<listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></ulink>: <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></ulink>:
Use this variable to specify "recommended-only" Use this variable to specify "recommended-only"
packages that you do not want installed. packages that you do not want installed.
</para></listitem> </para></listitem>
<listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></ulink>: <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></ulink>:
Use this variable to prevent all "recommended-only" Use this variable to prevent all "recommended-only"
packages from being installed. packages from being installed.
</para></listitem> </para></listitem>
<listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>: <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>:
Use this variable to prevent specific packages from Use this variable to prevent specific packages from
being installed regardless of whether they are being installed regardless of whether they are
"recommended-only" or not. "recommended-only" or not.
You need to realize that the build process could You need to realize that the build process could
fail with an error when you fail with an error when you
prevent the installation of a package whose presence prevent the installation of a package whose presence
is required by an installed package. is required by an installed package.
</para></listitem> </para></listitem>
@ -3393,7 +3393,7 @@
<para> <para>
Many pieces of software split functionality into optional Many pieces of software split functionality into optional
modules (or plugins) and the plugins that are built modules (or plug-ins) and the plug-ins that are built
might depend on configuration options. might depend on configuration options.
To avoid having to duplicate the logic that determines what To avoid having to duplicate the logic that determines what
modules are available in your recipe or to avoid having modules are available in your recipe or to avoid having
@ -4505,10 +4505,10 @@
<title>Examining Builds Using the Toaster API</title> <title>Examining Builds Using the Toaster API</title>
<para> <para>
Toaster is an Application Programming Interface (API) to the Toaster is an Application Programming Interface (API) to the
OpenEmbedded build system, which uses BitBake. OpenEmbedded build system, which uses BitBake.
The interface is a Representational State Transfer (REST) API The interface is a Representational State Transfer (REST) API
that queries for and returns build information using that queries for and returns build information using
<filename>GET</filename> and <filename>JSON</filename>. <filename>GET</filename> and <filename>JSON</filename>.
</para> </para>
@ -4528,16 +4528,16 @@
</para> </para>
<para> <para>
In summary, the search operation retrieves a set of objects from In summary, the search operation retrieves a set of objects from
a data store used to collect build information. a data store used to collect build information.
The result contains all the data for the objects being returned. The result contains all the data for the objects being returned.
You can order the results of the search by key and the search You can order the results of the search by key and the search
parameters are consistent for all object types. parameters are consistent for all object types.
</para> </para>
<para> <para>
For complete information on the API and its search operation For complete information on the API and its search operation
URI, parameters, and reposes, see the URI, parameters, and reposes, see the
<ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink> <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink>
Wiki page. Wiki page.
</para> </para>

4
documentation/profile-manual/profile-manual-usage.xml
View File

@ -3094,7 +3094,7 @@
If you already have an LTTng trace on a remote target and If you already have an LTTng trace on a remote target and
would like to view it in Eclipse on the host, you can easily would like to view it in Eclipse on the host, you can easily
copy it from the target to the host and import it into copy it from the target to the host and import it into
Eclipse to view it using the LTTng Eclipse plugin already Eclipse to view it using the LTTng Eclipse plug-in already
bundled in the Eclipse (Juno SR1 or greater). bundled in the Eclipse (Juno SR1 or greater).
</para> </para>
@ -3172,7 +3172,7 @@
<para> <para>
You can access extensive help information on how to use You can access extensive help information on how to use
the LTTng plugin to search and analyze captured traces via the LTTng plug-in to search and analyze captured traces via
the Eclipse help system: the Eclipse help system:
<literallayout class='monospaced'> <literallayout class='monospaced'>
Help | Help Contents | LTTng Plug-in User Guide Help | Help Contents | LTTng Plug-in User Guide