documentation: Scrubbed use of directory names

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

View File

@@ -357,7 +357,7 @@
to cause the build to use your own version of
the file.
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
<ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink>
using
@@ -369,7 +369,7 @@
The build for machine "one" will pick up your
machine-specific file as long as you have the
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
machine and the
<filename>bblayers.conf</filename> file includes
@@ -384,9 +384,9 @@
the file in a subdirectory specific to the
machine.
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
<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
only when building for machine "one" but the
build process locates the file more quickly.</para>
@@ -1957,7 +1957,7 @@
<link linkend='source-directory'>Source Directory</link>
top-level folder is <filename>~/poky</filename>:
<literallayout class='monospaced'>
$ cd ~/poky
$ cd poky
$ source oe-init-build-env
$ bitbake linux-yocto -c menuconfig
</literallayout>
@@ -2006,7 +2006,7 @@
<filename>x86</filename> architecture, the
<filename>.config</filename> file would be located here:
<literallayout class='monospaced'>
~/poky/build/tmp/work/qemux86-poky-linux/linux-yocto-3.4.11+git1+84f...
poky/build/tmp/work/qemux86-poky-linux/linux-yocto-3.4.11+git1+84f...
...656ed30-r1/linux-qemux86-standard-build
</literallayout>
<note>
@@ -2079,7 +2079,7 @@
kernel's configuration.
For example, suppose you had a set of configuration options in a file called
<filename>myconfig.cfg</filename>.
If you put that file inside a directory named <filename>/linux-yocto</filename>
If you put that file inside a directory named <filename>linux-yocto</filename>
that resides in the same directory as the kernel's append file and then add
a <filename>SRC_URI</filename> statement such as the following to the kernel's append file,
those configuration options will be picked up and applied when the kernel is built.
@@ -5271,7 +5271,7 @@
<listitem><para>You have checked out the
<filename>dora-toaster</filename> branch:
<literallayout class='monospaced'>
$ cd ~/poky
$ cd poky
$ git checkout -b dora-toaster origin/dora-toaster
</literallayout></para></listitem>
<listitem><para>Be sure your build machine has
@@ -5629,7 +5629,7 @@
<para>
Downloaded archives reside in the
<link linkend='build-directory'>Build Directory</link> in
<filename>/tmp</filename> and are cleared up when they are no longer in use.
<filename>tmp</filename> and are cleared up when they are no longer in use.
</para>
<para>

View File

@@ -1675,7 +1675,7 @@
the following is the work directory for the <filename>acl</filename> recipe that
creates the <filename>acl</filename> package:
<literallayout class='monospaced'>
~/poky/build/tmp/work/i586-poky-linux/acl/2.2.51-r3/
poky/build/tmp/work/i586-poky-linux/acl/2.2.51-r3/
</literallayout>
</para>
@@ -1691,8 +1691,8 @@
for the <filename>acl</filename> package that is being
built for a MIPS-based device:
<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/acl-2.2.51
poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2
poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2/acl-2.2.51
</literallayout>
</para>

View File

@@ -1462,8 +1462,8 @@
<para>For help on using these scripts, simply provide the
<filename>-h</filename> argument as follows:
<literallayout class='monospaced'>
$ ~/poky/scripts/create-pull-request -h
$ ~/poky/scripts/send-pull-request -h
$ poky/scripts/create-pull-request -h
$ poky/scripts/send-pull-request -h
</literallayout></para></listitem>
</itemizedlist>
</para>