diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-11-07 14:23:56 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:06 +0000 |
commit | dd6b2ef9e7a460da329b81ff46f18f2fb657e6bc (patch) | |
tree | 0d74b91cb2406017aadcb5ea7d49edf464026551 /documentation/dev-manual | |
parent | 30d7f5263aabffcd068ba3ff3932cba3a2ebef87 (diff) | |
download | poky-dd6b2ef9e7a460da329b81ff46f18f2fb657e6bc.tar.gz |
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>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 18 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 6 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 4 |
3 files changed, 14 insertions, 14 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 4aecb449f3..7d5063b79b 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -357,7 +357,7 @@ | |||
357 | to cause the build to use your own version of | 357 | to cause the build to use your own version of |
358 | the file. | 358 | the file. |
359 | For example, an append file in your layer at | 359 | For example, an append file in your layer at |
360 | <filename>/meta-one/recipes-core/base-files/base-files.bbappend</filename> | 360 | <filename>meta-one/recipes-core/base-files/base-files.bbappend</filename> |
361 | could extend | 361 | could extend |
362 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> | 362 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> |
363 | using | 363 | using |
@@ -369,7 +369,7 @@ | |||
369 | The build for machine "one" will pick up your | 369 | The build for machine "one" will pick up your |
370 | machine-specific file as long as you have the | 370 | machine-specific file as long as you have the |
371 | file in | 371 | file in |
372 | <filename>/meta-one/recipes-core/base-files/base-files/</filename>. | 372 | <filename>meta-one/recipes-core/base-files/base-files/</filename>. |
373 | However, if you are building for a different | 373 | However, if you are building for a different |
374 | machine and the | 374 | machine and the |
375 | <filename>bblayers.conf</filename> file includes | 375 | <filename>bblayers.conf</filename> file includes |
@@ -384,9 +384,9 @@ | |||
384 | the file in a subdirectory specific to the | 384 | the file in a subdirectory specific to the |
385 | machine. | 385 | machine. |
386 | For example, rather than placing the file in | 386 | For example, rather than placing the file in |
387 | <filename>/meta-one/recipes-core/base-files/base-files/</filename> | 387 | <filename>meta-one/recipes-core/base-files/base-files/</filename> |
388 | as shown above, put it in | 388 | as shown above, put it in |
389 | <filename>/meta-one/recipes-core/base-files/base-files/one/</filename>. | 389 | <filename>meta-one/recipes-core/base-files/base-files/one/</filename>. |
390 | Not only does this make sure the file is used | 390 | Not only does this make sure the file is used |
391 | only when building for machine "one" but the | 391 | only when building for machine "one" but the |
392 | build process locates the file more quickly.</para> | 392 | build process locates the file more quickly.</para> |
@@ -1957,7 +1957,7 @@ | |||
1957 | <link linkend='source-directory'>Source Directory</link> | 1957 | <link linkend='source-directory'>Source Directory</link> |
1958 | top-level folder is <filename>~/poky</filename>: | 1958 | top-level folder is <filename>~/poky</filename>: |
1959 | <literallayout class='monospaced'> | 1959 | <literallayout class='monospaced'> |
1960 | $ cd ~/poky | 1960 | $ cd poky |
1961 | $ source oe-init-build-env | 1961 | $ source oe-init-build-env |
1962 | $ bitbake linux-yocto -c menuconfig | 1962 | $ bitbake linux-yocto -c menuconfig |
1963 | </literallayout> | 1963 | </literallayout> |
@@ -2006,7 +2006,7 @@ | |||
2006 | <filename>x86</filename> architecture, the | 2006 | <filename>x86</filename> architecture, the |
2007 | <filename>.config</filename> file would be located here: | 2007 | <filename>.config</filename> file would be located here: |
2008 | <literallayout class='monospaced'> | 2008 | <literallayout class='monospaced'> |
2009 | ~/poky/build/tmp/work/qemux86-poky-linux/linux-yocto-3.4.11+git1+84f... | 2009 | poky/build/tmp/work/qemux86-poky-linux/linux-yocto-3.4.11+git1+84f... |
2010 | ...656ed30-r1/linux-qemux86-standard-build | 2010 | ...656ed30-r1/linux-qemux86-standard-build |
2011 | </literallayout> | 2011 | </literallayout> |
2012 | <note> | 2012 | <note> |
@@ -2079,7 +2079,7 @@ | |||
2079 | kernel's configuration. | 2079 | kernel's configuration. |
2080 | For example, suppose you had a set of configuration options in a file called | 2080 | For example, suppose you had a set of configuration options in a file called |
2081 | <filename>myconfig.cfg</filename>. | 2081 | <filename>myconfig.cfg</filename>. |
2082 | If you put that file inside a directory named <filename>/linux-yocto</filename> | 2082 | If you put that file inside a directory named <filename>linux-yocto</filename> |
2083 | that resides in the same directory as the kernel's append file and then add | 2083 | that resides in the same directory as the kernel's append file and then add |
2084 | a <filename>SRC_URI</filename> statement such as the following to the kernel's append file, | 2084 | a <filename>SRC_URI</filename> statement such as the following to the kernel's append file, |
2085 | those configuration options will be picked up and applied when the kernel is built. | 2085 | those configuration options will be picked up and applied when the kernel is built. |
@@ -5271,7 +5271,7 @@ | |||
5271 | <listitem><para>You have checked out the | 5271 | <listitem><para>You have checked out the |
5272 | <filename>dora-toaster</filename> branch: | 5272 | <filename>dora-toaster</filename> branch: |
5273 | <literallayout class='monospaced'> | 5273 | <literallayout class='monospaced'> |
5274 | $ cd ~/poky | 5274 | $ cd poky |
5275 | $ git checkout -b dora-toaster origin/dora-toaster | 5275 | $ git checkout -b dora-toaster origin/dora-toaster |
5276 | </literallayout></para></listitem> | 5276 | </literallayout></para></listitem> |
5277 | <listitem><para>Be sure your build machine has | 5277 | <listitem><para>Be sure your build machine has |
@@ -5629,7 +5629,7 @@ | |||
5629 | <para> | 5629 | <para> |
5630 | Downloaded archives reside in the | 5630 | Downloaded archives reside in the |
5631 | <link linkend='build-directory'>Build Directory</link> in | 5631 | <link linkend='build-directory'>Build Directory</link> in |
5632 | <filename>/tmp</filename> and are cleared up when they are no longer in use. | 5632 | <filename>tmp</filename> and are cleared up when they are no longer in use. |
5633 | </para> | 5633 | </para> |
5634 | 5634 | ||
5635 | <para> | 5635 | <para> |
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 46cd5b30a1..8b0bfc6fa8 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -1675,7 +1675,7 @@ | |||
1675 | the following is the work directory for the <filename>acl</filename> recipe that | 1675 | the following is the work directory for the <filename>acl</filename> recipe that |
1676 | creates the <filename>acl</filename> package: | 1676 | creates the <filename>acl</filename> package: |
1677 | <literallayout class='monospaced'> | 1677 | <literallayout class='monospaced'> |
1678 | ~/poky/build/tmp/work/i586-poky-linux/acl/2.2.51-r3/ | 1678 | poky/build/tmp/work/i586-poky-linux/acl/2.2.51-r3/ |
1679 | </literallayout> | 1679 | </literallayout> |
1680 | </para> | 1680 | </para> |
1681 | 1681 | ||
@@ -1691,8 +1691,8 @@ | |||
1691 | for the <filename>acl</filename> package that is being | 1691 | for the <filename>acl</filename> package that is being |
1692 | built for a MIPS-based device: | 1692 | built for a MIPS-based device: |
1693 | <literallayout class='monospaced'> | 1693 | <literallayout class='monospaced'> |
1694 | ~/poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2 | 1694 | poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2 |
1695 | ~/poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2/acl-2.2.51 | 1695 | poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2/acl-2.2.51 |
1696 | </literallayout> | 1696 | </literallayout> |
1697 | </para> | 1697 | </para> |
1698 | 1698 | ||
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 0dc4bd58bb..600c789a6d 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -1462,8 +1462,8 @@ | |||
1462 | <para>For help on using these scripts, simply provide the | 1462 | <para>For help on using these scripts, simply provide the |
1463 | <filename>-h</filename> argument as follows: | 1463 | <filename>-h</filename> argument as follows: |
1464 | <literallayout class='monospaced'> | 1464 | <literallayout class='monospaced'> |
1465 | $ ~/poky/scripts/create-pull-request -h | 1465 | $ poky/scripts/create-pull-request -h |
1466 | $ ~/poky/scripts/send-pull-request -h | 1466 | $ poky/scripts/send-pull-request -h |
1467 | </literallayout></para></listitem> | 1467 | </literallayout></para></listitem> |
1468 | </itemizedlist> | 1468 | </itemizedlist> |
1469 | </para> | 1469 | </para> |