mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-04-25 15:32:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Scrubbed use of directory names

Browse Source 
There was inconsistent use of the way directory names were
handled throughout the YP documentation.  I have scrubbed the
set and replaced many instances such as the following:

meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)

I basically got rid of leading slash characters.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441)

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-11-07 14:23:56 -08:00
committed by Richard Purdie
parent 30d7f5263a
commit dd6b2ef9e7
12 changed files with 49 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/ref-manual/migration.xml
View File

@@ -829,10 +829,10 @@
</section>
<section id='migration-1.5-run'>
<title><filename>/run</filename></title>
<title><filename>run</filename></title>
<para>
The <filename>/run</filename> directory from the Filesystem
The <filename>run</filename> directory from the Filesystem
Hierarchy Standard 3.0 has been introduced.
You can find some of the implications for this change
<ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873'>here</ulink>.
@@ -1033,7 +1033,7 @@
</para></listitem>
<listitem><para>
<filename>base-files</filename>: Remove the unnecessary
<filename>/media/xxx</filename> directories.
<filename>media/xxx</filename> directories.
</para></listitem>
<listitem><para>
<filename>alsa-state</filename>: Provide an empty

2
documentation/ref-manual/ref-bitbake.xml
View File

@@ -222,7 +222,7 @@
<para>
As each task completes, a timestamp is written to the directory specified by the
<filename><link linkend='var-STAMP'>STAMP</link></filename> variable.
On subsequent runs, BitBake looks within the <filename>/build/tmp/stamps</filename>
On subsequent runs, BitBake looks within the <filename>build/tmp/stamps</filename>
directory and does not rerun
tasks that are already completed unless a timestamp is found to be invalid.
Currently, invalid timestamps are only considered on a per

2
documentation/ref-manual/ref-features.xml
View File

@@ -38,7 +38,7 @@
Here is an example that discovers the recipes whose build is potentially
changed based on a given feature:
<literallayout class='monospaced'>
$ cd $HOME/poky
$ cd poky
$ git grep 'contains.*MACHINE_FEATURES.*&lt;feature&gt;'
</literallayout>
</para>

20
documentation/ref-manual/ref-variables.xml
View File

@@ -701,10 +701,10 @@
<para>
The following example uses a complete regular expression
to tell BitBake to ignore all recipe and recipe append
files in the <filename>/meta-ti/recipes-misc/</filename>
files in the <filename>meta-ti/recipes-misc/</filename>
directory:
<literallayout class='monospaced'>
BBMASK = "/meta-ti/recipes-misc/"
BBMASK = "meta-ti/recipes-misc/"
</literallayout>
If you want to mask out multiple directories or recipes,
use the vertical bar to separate the regular expression
@@ -999,7 +999,7 @@
<filename>/etc</filename> or <filename>${bindir}</filename> rather
than <filename>/usr/bin</filename>.
You can find a list of these variables at the top of the
<filename>/meta/conf/bitbake.conf</filename> file in the
<filename>meta/conf/bitbake.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</note>
</glossdef>
@@ -1036,7 +1036,7 @@
<glossdef>
<para>
Specifies the parent directory of the OpenEmbedded
Core Metadata layer (i.e. <filename>/meta</filename>).
Core Metadata layer (i.e. <filename>meta</filename>).
</para>
<para>
@@ -1362,7 +1362,7 @@
<para>
You can set this directory by defining the
<filename>DL_DIR</filename> variable in the
<filename>/conf/local.conf</filename> file.
<filename>conf/local.conf</filename> file.
This directory is self-maintaining and you should not have
to touch it.
By default, the directory is <filename>downloads</filename>
@@ -1712,7 +1712,7 @@
<filename>/etc</filename>, or <filename>${bindir}</filename> rather
than <filename>/usr/bin</filename>.
You can find a list of these variables at the top of the
<filename>/meta/conf/bitbake.conf</filename> file in the
<filename>meta/conf/bitbake.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</note>
@@ -2068,7 +2068,7 @@
to a default value using the <filename>?=</filename> operator, using a
<filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename>
will result in unexpected behavior when used in
<filename>/conf/local.conf</filename>.
<filename>conf/local.conf</filename>.
Furthermore, the same operation from within an image recipe may or may not
succeed depending on the specific situation.
In both these cases, the behavior is contrary to how most users expect
@@ -4770,7 +4770,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
to keep the unpacked recipe for <filename>db</filename>
is the following:
<literallayout class='monospaced'>
~/poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
</literallayout>
</para>
</glossdef>
@@ -5888,7 +5888,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
In this case, the working directory the build system uses to build
the <filename>v86d</filename> package is the following:
<literallayout class='monospaced'>
~/poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0
poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0
</literallayout>
</para>
@@ -5905,7 +5905,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
the <filename>acl</filename> recipe, which is being built for a
MIPS-based device, is the following:
<literallayout class='monospaced'>
~/poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2
poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2
</literallayout>
</para>
</glossdef>

6
documentation/ref-manual/technical-details.xml
View File

@@ -1149,7 +1149,7 @@
recipe-by-recipe basis through the <filename>LICENSE_FLAGS</filename> variable
definition in the affected recipe.
For instance, the
<filename>$HOME/poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
<filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
recipe contains the following statement:
<literallayout class='monospaced'>
LICENSE_FLAGS = "commercial"
@@ -1165,7 +1165,7 @@
<filename>LICENSE_FLAGS_WHITELIST</filename> variable, which is a variable
typically defined in your <filename>local.conf</filename> file.
For example, to enable
the <filename>$HOME/poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
the <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
package, you could add either the string
"commercial_gst-plugins-ugly" or the more general string
"commercial" to <filename>LICENSE_FLAGS_WHITELIST</filename>.
@@ -1312,7 +1312,7 @@
<para>
Other helpful variables related to commercial
license handling exist and are defined in the
<filename>$HOME/poky/meta/conf/distro/include/default-distrovars.inc</filename> file:
<filename>poky/meta/conf/distro/include/default-distrovars.inc</filename> file:
<literallayout class='monospaced'>
COMMERCIAL_AUDIO_PLUGINS ?= ""
COMMERCIAL_VIDEO_PLUGINS ?= ""

2
documentation/ref-manual/usingpoky.xml
View File

@@ -62,7 +62,7 @@
<para>
The <filename>target</filename> is the name of the recipe you want to build.
Common targets are the images in <filename>meta/recipes-core/images</filename>,
<filename>/meta/recipes-sato/images</filename>, etc. all found in the
<filename>meta/recipes-sato/images</filename>, etc. all found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
Or, the target can be the name of a recipe for a specific piece of software such as
BusyBox.