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/ref-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/ref-manual')
-rw-r--r-- | documentation/ref-manual/migration.xml | 6 | ||||
-rw-r--r-- | documentation/ref-manual/ref-bitbake.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-features.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 20 | ||||
-rw-r--r-- | documentation/ref-manual/technical-details.xml | 6 | ||||
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 2 |
6 files changed, 19 insertions, 19 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index a3a3e88a07..dc24628e3c 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml | |||
@@ -829,10 +829,10 @@ | |||
829 | </section> | 829 | </section> |
830 | 830 | ||
831 | <section id='migration-1.5-run'> | 831 | <section id='migration-1.5-run'> |
832 | <title><filename>/run</filename></title> | 832 | <title><filename>run</filename></title> |
833 | 833 | ||
834 | <para> | 834 | <para> |
835 | The <filename>/run</filename> directory from the Filesystem | 835 | The <filename>run</filename> directory from the Filesystem |
836 | Hierarchy Standard 3.0 has been introduced. | 836 | Hierarchy Standard 3.0 has been introduced. |
837 | You can find some of the implications for this change | 837 | You can find some of the implications for this change |
838 | <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873'>here</ulink>. | 838 | <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873'>here</ulink>. |
@@ -1033,7 +1033,7 @@ | |||
1033 | </para></listitem> | 1033 | </para></listitem> |
1034 | <listitem><para> | 1034 | <listitem><para> |
1035 | <filename>base-files</filename>: Remove the unnecessary | 1035 | <filename>base-files</filename>: Remove the unnecessary |
1036 | <filename>/media/xxx</filename> directories. | 1036 | <filename>media/xxx</filename> directories. |
1037 | </para></listitem> | 1037 | </para></listitem> |
1038 | <listitem><para> | 1038 | <listitem><para> |
1039 | <filename>alsa-state</filename>: Provide an empty | 1039 | <filename>alsa-state</filename>: Provide an empty |
diff --git a/documentation/ref-manual/ref-bitbake.xml b/documentation/ref-manual/ref-bitbake.xml index b587d46caa..e24ea45281 100644 --- a/documentation/ref-manual/ref-bitbake.xml +++ b/documentation/ref-manual/ref-bitbake.xml | |||
@@ -222,7 +222,7 @@ | |||
222 | <para> | 222 | <para> |
223 | As each task completes, a timestamp is written to the directory specified by the | 223 | As each task completes, a timestamp is written to the directory specified by the |
224 | <filename><link linkend='var-STAMP'>STAMP</link></filename> variable. | 224 | <filename><link linkend='var-STAMP'>STAMP</link></filename> variable. |
225 | On subsequent runs, BitBake looks within the <filename>/build/tmp/stamps</filename> | 225 | On subsequent runs, BitBake looks within the <filename>build/tmp/stamps</filename> |
226 | directory and does not rerun | 226 | directory and does not rerun |
227 | tasks that are already completed unless a timestamp is found to be invalid. | 227 | tasks that are already completed unless a timestamp is found to be invalid. |
228 | Currently, invalid timestamps are only considered on a per | 228 | Currently, invalid timestamps are only considered on a per |
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 3f216e3a64..dedcf67e33 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml | |||
@@ -38,7 +38,7 @@ | |||
38 | Here is an example that discovers the recipes whose build is potentially | 38 | Here is an example that discovers the recipes whose build is potentially |
39 | changed based on a given feature: | 39 | changed based on a given feature: |
40 | <literallayout class='monospaced'> | 40 | <literallayout class='monospaced'> |
41 | $ cd $HOME/poky | 41 | $ cd poky |
42 | $ git grep 'contains.*MACHINE_FEATURES.*<feature>' | 42 | $ git grep 'contains.*MACHINE_FEATURES.*<feature>' |
43 | </literallayout> | 43 | </literallayout> |
44 | </para> | 44 | </para> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 84deee8899..2b0e8909fe 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -701,10 +701,10 @@ | |||
701 | <para> | 701 | <para> |
702 | The following example uses a complete regular expression | 702 | The following example uses a complete regular expression |
703 | to tell BitBake to ignore all recipe and recipe append | 703 | to tell BitBake to ignore all recipe and recipe append |
704 | files in the <filename>/meta-ti/recipes-misc/</filename> | 704 | files in the <filename>meta-ti/recipes-misc/</filename> |
705 | directory: | 705 | directory: |
706 | <literallayout class='monospaced'> | 706 | <literallayout class='monospaced'> |
707 | BBMASK = "/meta-ti/recipes-misc/" | 707 | BBMASK = "meta-ti/recipes-misc/" |
708 | </literallayout> | 708 | </literallayout> |
709 | If you want to mask out multiple directories or recipes, | 709 | If you want to mask out multiple directories or recipes, |
710 | use the vertical bar to separate the regular expression | 710 | use the vertical bar to separate the regular expression |
@@ -999,7 +999,7 @@ | |||
999 | <filename>/etc</filename> or <filename>${bindir}</filename> rather | 999 | <filename>/etc</filename> or <filename>${bindir}</filename> rather |
1000 | than <filename>/usr/bin</filename>. | 1000 | than <filename>/usr/bin</filename>. |
1001 | You can find a list of these variables at the top of the | 1001 | You can find a list of these variables at the top of the |
1002 | <filename>/meta/conf/bitbake.conf</filename> file in the | 1002 | <filename>meta/conf/bitbake.conf</filename> file in the |
1003 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 1003 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
1004 | </note> | 1004 | </note> |
1005 | </glossdef> | 1005 | </glossdef> |
@@ -1036,7 +1036,7 @@ | |||
1036 | <glossdef> | 1036 | <glossdef> |
1037 | <para> | 1037 | <para> |
1038 | Specifies the parent directory of the OpenEmbedded | 1038 | Specifies the parent directory of the OpenEmbedded |
1039 | Core Metadata layer (i.e. <filename>/meta</filename>). | 1039 | Core Metadata layer (i.e. <filename>meta</filename>). |
1040 | </para> | 1040 | </para> |
1041 | 1041 | ||
1042 | <para> | 1042 | <para> |
@@ -1362,7 +1362,7 @@ | |||
1362 | <para> | 1362 | <para> |
1363 | You can set this directory by defining the | 1363 | You can set this directory by defining the |
1364 | <filename>DL_DIR</filename> variable in the | 1364 | <filename>DL_DIR</filename> variable in the |
1365 | <filename>/conf/local.conf</filename> file. | 1365 | <filename>conf/local.conf</filename> file. |
1366 | This directory is self-maintaining and you should not have | 1366 | This directory is self-maintaining and you should not have |
1367 | to touch it. | 1367 | to touch it. |
1368 | By default, the directory is <filename>downloads</filename> | 1368 | By default, the directory is <filename>downloads</filename> |
@@ -1712,7 +1712,7 @@ | |||
1712 | <filename>/etc</filename>, or <filename>${bindir}</filename> rather | 1712 | <filename>/etc</filename>, or <filename>${bindir}</filename> rather |
1713 | than <filename>/usr/bin</filename>. | 1713 | than <filename>/usr/bin</filename>. |
1714 | You can find a list of these variables at the top of the | 1714 | You can find a list of these variables at the top of the |
1715 | <filename>/meta/conf/bitbake.conf</filename> file in the | 1715 | <filename>meta/conf/bitbake.conf</filename> file in the |
1716 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 1716 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
1717 | </note> | 1717 | </note> |
1718 | 1718 | ||
@@ -2068,7 +2068,7 @@ | |||
2068 | to a default value using the <filename>?=</filename> operator, using a | 2068 | to a default value using the <filename>?=</filename> operator, using a |
2069 | <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename> | 2069 | <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename> |
2070 | will result in unexpected behavior when used in | 2070 | will result in unexpected behavior when used in |
2071 | <filename>/conf/local.conf</filename>. | 2071 | <filename>conf/local.conf</filename>. |
2072 | Furthermore, the same operation from within an image recipe may or may not | 2072 | Furthermore, the same operation from within an image recipe may or may not |
2073 | succeed depending on the specific situation. | 2073 | succeed depending on the specific situation. |
2074 | In both these cases, the behavior is contrary to how most users expect | 2074 | 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" | |||
4770 | to keep the unpacked recipe for <filename>db</filename> | 4770 | to keep the unpacked recipe for <filename>db</filename> |
4771 | is the following: | 4771 | is the following: |
4772 | <literallayout class='monospaced'> | 4772 | <literallayout class='monospaced'> |
4773 | ~/poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 | 4773 | poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 |
4774 | </literallayout> | 4774 | </literallayout> |
4775 | </para> | 4775 | </para> |
4776 | </glossdef> | 4776 | </glossdef> |
@@ -5888,7 +5888,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
5888 | In this case, the working directory the build system uses to build | 5888 | In this case, the working directory the build system uses to build |
5889 | the <filename>v86d</filename> package is the following: | 5889 | the <filename>v86d</filename> package is the following: |
5890 | <literallayout class='monospaced'> | 5890 | <literallayout class='monospaced'> |
5891 | ~/poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0 | 5891 | poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0 |
5892 | </literallayout> | 5892 | </literallayout> |
5893 | </para> | 5893 | </para> |
5894 | 5894 | ||
@@ -5905,7 +5905,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
5905 | the <filename>acl</filename> recipe, which is being built for a | 5905 | the <filename>acl</filename> recipe, which is being built for a |
5906 | MIPS-based device, is the following: | 5906 | MIPS-based device, is the following: |
5907 | <literallayout class='monospaced'> | 5907 | <literallayout class='monospaced'> |
5908 | ~/poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2 | 5908 | poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2 |
5909 | </literallayout> | 5909 | </literallayout> |
5910 | </para> | 5910 | </para> |
5911 | </glossdef> | 5911 | </glossdef> |
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 4d1c2e3f4e..6d4c6b712c 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
@@ -1149,7 +1149,7 @@ | |||
1149 | recipe-by-recipe basis through the <filename>LICENSE_FLAGS</filename> variable | 1149 | recipe-by-recipe basis through the <filename>LICENSE_FLAGS</filename> variable |
1150 | definition in the affected recipe. | 1150 | definition in the affected recipe. |
1151 | For instance, the | 1151 | For instance, the |
1152 | <filename>$HOME/poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> | 1152 | <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> |
1153 | recipe contains the following statement: | 1153 | recipe contains the following statement: |
1154 | <literallayout class='monospaced'> | 1154 | <literallayout class='monospaced'> |
1155 | LICENSE_FLAGS = "commercial" | 1155 | LICENSE_FLAGS = "commercial" |
@@ -1165,7 +1165,7 @@ | |||
1165 | <filename>LICENSE_FLAGS_WHITELIST</filename> variable, which is a variable | 1165 | <filename>LICENSE_FLAGS_WHITELIST</filename> variable, which is a variable |
1166 | typically defined in your <filename>local.conf</filename> file. | 1166 | typically defined in your <filename>local.conf</filename> file. |
1167 | For example, to enable | 1167 | For example, to enable |
1168 | the <filename>$HOME/poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> | 1168 | the <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> |
1169 | package, you could add either the string | 1169 | package, you could add either the string |
1170 | "commercial_gst-plugins-ugly" or the more general string | 1170 | "commercial_gst-plugins-ugly" or the more general string |
1171 | "commercial" to <filename>LICENSE_FLAGS_WHITELIST</filename>. | 1171 | "commercial" to <filename>LICENSE_FLAGS_WHITELIST</filename>. |
@@ -1312,7 +1312,7 @@ | |||
1312 | <para> | 1312 | <para> |
1313 | Other helpful variables related to commercial | 1313 | Other helpful variables related to commercial |
1314 | license handling exist and are defined in the | 1314 | license handling exist and are defined in the |
1315 | <filename>$HOME/poky/meta/conf/distro/include/default-distrovars.inc</filename> file: | 1315 | <filename>poky/meta/conf/distro/include/default-distrovars.inc</filename> file: |
1316 | <literallayout class='monospaced'> | 1316 | <literallayout class='monospaced'> |
1317 | COMMERCIAL_AUDIO_PLUGINS ?= "" | 1317 | COMMERCIAL_AUDIO_PLUGINS ?= "" |
1318 | COMMERCIAL_VIDEO_PLUGINS ?= "" | 1318 | COMMERCIAL_VIDEO_PLUGINS ?= "" |
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 49166e15bf..b9df733f3f 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -62,7 +62,7 @@ | |||
62 | <para> | 62 | <para> |
63 | The <filename>target</filename> is the name of the recipe you want to build. | 63 | The <filename>target</filename> is the name of the recipe you want to build. |
64 | Common targets are the images in <filename>meta/recipes-core/images</filename>, | 64 | Common targets are the images in <filename>meta/recipes-core/images</filename>, |
65 | <filename>/meta/recipes-sato/images</filename>, etc. all found in the | 65 | <filename>meta/recipes-sato/images</filename>, etc. all found in the |
66 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 66 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
67 | Or, the target can be the name of a recipe for a specific piece of software such as | 67 | Or, the target can be the name of a recipe for a specific piece of software such as |
68 | BusyBox. | 68 | BusyBox. |