diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index afd8e49c14..7f59c39f2d 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -235,10 +235,10 @@ 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. - +
Avoid "Overlaying" Entire Recipes @@ -270,19 +270,19 @@ the layer to which it originally belongs. If this is the case, you need to address that deficiency 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. The Source Directory does not have MySQL or PostgreSQL. - However, OpenEmbedded's layer meta-oe + However, OpenEmbedded's layer meta-oe does. Consequently, meta-oe uses .bbappend files to modify the QT_SQL_DRIVER_FLAGS variable to - enable the appropriate plugins. - This variable was added to the qt4.inc - include file in the Source Directory specifically to allow + enable the appropriate plug-ins. + This variable was added to the qt4.inc + include file in the Source Directory specifically to allow the meta-oe layer to be able to control - which plugins are built. + which plug-ins are built.
@@ -290,105 +290,105 @@ Structure Your Layers - Proper use of overrides within append files and placement - of machine-specific files within your layer can ensure that + Proper use of overrides within append files and placement + of machine-specific files within your layer can ensure that a build is not using the wrong Metadata and negatively impacting a build for a different machine. Following are some examples: - Modifying Variables to support + Modifying Variables to support a different machine: Suppose you have a layer named - meta-one that adds support + meta-one that adds support for building machine "one". - To do so, you use an append file named - base-files.bbappend and - create a dependency on "foo" by altering the + To do so, you use an append file named + base-files.bbappend and + create a dependency on "foo" by altering the DEPENDS variable: DEPENDS = "foo" - The dependency is created during any build that - includes the layer + The dependency is created during any build that + includes the layer meta-one. - However, you might not want this dependency + However, you might not want this dependency for all machines. - For example, suppose you are building for - machine "two" but your - bblayers.conf file has the + For example, suppose you are building for + machine "two" but your + bblayers.conf file has the meta-one layer included. - During the build, the - base-files for machine - "two" will also have the dependency on + During the build, the + base-files for machine + "two" will also have the dependency on foo. - To make sure your changes apply only when - building machine "one", use a machine override + To make sure your changes apply only when + building machine "one", use a machine override with the DEPENDS statement: DEPENDS_one = "foo" - You should follow the same strategy when using - _append and + You should follow the same strategy when using + _append and _prepend operations: DEPENDS_append_one = " foo" DEPENDS_prepend_one = "foo " - Avoiding "+=" and "=+" and using - machine-specific + Avoiding "+=" and "=+" and using + machine-specific _append - and _prepend operations + and _prepend operations is recommended as well. - Place Machine-Specific Files + Place Machine-Specific Files in Machine-Specific Locations: - When you have a base recipe, such as - base-files.bb, that - contains a + When you have a base recipe, such as + base-files.bb, that + contains a SRC_URI 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. - For example, an append file in your layer at + For example, an append file in your layer at /meta-one/recipes-core/base-files/base-files.bbappend - could extend + could extend FILESPATH - using + using FILESEXTRAPATHS as follows: FILESEXTRAPATHS_prepend := "${THISDIR}/${BPN}:" - The build for machine "one" will pick up your - machine-specific file as long as you have the + The build for machine "one" will pick up your + machine-specific file as long as you have the file in /meta-one/recipes-core/base-files/base-files/. - However, if you are building for a different - machine and the + However, if you are building for a different + machine and the bblayers.conf file includes - the meta-one layer and - the location of your machine-specific file is + the meta-one layer and + the location of your machine-specific file is the first location where that file is found - according to FILESPATH, - builds for all machines will also use that + according to FILESPATH, + builds for all machines will also use that machine-specific file. You can make sure that a machine-specific 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. - For example, rather than placing the file in + For example, rather than placing the file in /meta-one/recipes-core/base-files/base-files/ - as shown above, put it in + as shown above, put it in /meta-one/recipes-core/base-files/base-files/one/. - Not only does this make sure the file is used - only when building for machine "one" but the + Not only does this make sure the file is used + only when building for machine "one" but the build process locates the file more quickly. In summary, you need to place all files referenced from SRC_URI - in a machine-specific subdirectory within the - layer in order to restrict those files to + in a machine-specific subdirectory within the + layer in order to restrict those files to machine-specific builds. @@ -2596,8 +2596,8 @@ If you have distro-specific configuration files that are included by an existing recipe, you should add a .bbappend for those. - For general information and recommendations - on how to add recipes to your layer, see the + For general information and recommendations + on how to add recipes to your layer, see the "Creating Your Own Layer" and "Best Practices to Follow When Creating Layers" @@ -3076,7 +3076,7 @@ Excluding Packages from an Image - You might find it necessary to prevent specific packages + You might find it necessary to prevent specific packages from being installed into an image. If so, you can use several variables to direct the build system to essentially ignore installing recommended packages @@ -3084,31 +3084,31 @@ - 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. Each of these variables only works with IPK and RPM package types. Support for Debian packages does not exist. - Also, you can use these variables from your - local.conf file or attach them to a + Also, you can use these variables from your + local.conf file or attach them to a 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. BAD_RECOMMENDATIONS: - Use this variable to specify "recommended-only" + Use this variable to specify "recommended-only" packages that you do not want installed. NO_RECOMMENDATIONS: - Use this variable to prevent all "recommended-only" + Use this variable to prevent all "recommended-only" packages from being installed. PACKAGE_EXCLUDE: - Use this variable to prevent specific packages from + Use this variable to prevent specific packages from being installed regardless of whether they are "recommended-only" or not. - You need to realize that the build process could - fail with an error when you + You need to realize that the build process could + fail with an error when you prevent the installation of a package whose presence is required by an installed package. @@ -3393,7 +3393,7 @@ 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. To avoid having to duplicate the logic that determines what modules are available in your recipe or to avoid having @@ -4505,10 +4505,10 @@ Examining Builds Using the Toaster API - Toaster is an Application Programming Interface (API) to the + Toaster is an Application Programming Interface (API) to the OpenEmbedded build system, which uses BitBake. 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 GET and JSON. @@ -4528,16 +4528,16 @@ - In summary, the search operation retrieves a set of objects from - a data store used to collect build information. + In summary, the search operation retrieves a set of objects from + a data store used to collect build information. 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. For complete information on the API and its search operation - URI, parameters, and reposes, see the + URI, parameters, and reposes, see the REST API Contracts Wiki page. diff --git a/documentation/profile-manual/profile-manual-usage.xml b/documentation/profile-manual/profile-manual-usage.xml index b0c2235dc6..8fef7d60ad 100644 --- a/documentation/profile-manual/profile-manual-usage.xml +++ b/documentation/profile-manual/profile-manual-usage.xml @@ -3094,7 +3094,7 @@ 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 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). @@ -3172,7 +3172,7 @@ 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: Help | Help Contents | LTTng Plug-in User Guide