diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-13 17:47:10 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-06-22 09:16:42 +0100 |
commit | 74bf586c940d20fc5546a60a290545c7c0edecb0 (patch) | |
tree | 5887ef777422efab49cc0ff37de17cd736faa242 /documentation | |
parent | b8b87dd690ef2f828c21937ec82c2d1dab405734 (diff) | |
download | openembedded-core-contrib-74bf586c940d20fc5546a60a290545c7c0edecb0.tar.gz |
documentation: Fixed links for "build-directory" term.
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
24 files changed, 117 insertions, 108 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 0dcc65b767..9226e5cdd4 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -98,7 +98,7 @@ This root is what you add to the <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> variable in the <filename>conf/bblayers.conf</filename> file found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, which is established after you run one of the OpenEmbedded build environment setup scripts (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 4a7306fb24..d73b663250 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -655,7 +655,7 @@ <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename> variable in your <filename>conf/bblayers.conf</filename> file, which is found in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. The following example shows how to enable a layer named <filename>meta-mylayer</filename>: <literallayout class='monospaced'> @@ -1192,7 +1192,7 @@ from within a recipe and using <filename>EXTRA_IMAGE_FEATURES</filename> from within your <filename>local.conf</filename> file, which is found in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. </para> <para> @@ -1539,7 +1539,7 @@ <para> To run the tool, you just need to be in your - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> and have sourced the build environment setup script (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink> @@ -2027,7 +2027,7 @@ or <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>) and you are in the - <link linkend='build-directory'>Build Directory</link>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, use BitBake to process your recipe. All you need to provide is the <filename><replaceable>basename</replaceable></filename> of the recipe as described @@ -4238,7 +4238,7 @@ combination of multiple libraries you want to build. You accomplish this through your <filename>local.conf</filename> configuration file in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. An example configuration would be as follows: <literallayout class='monospaced'> MACHINE = "qemux86-64" @@ -4314,7 +4314,7 @@ <listitem><para>A unique architecture is defined for the Multilib packages, along with creating a unique deploy folder under <filename>tmp/deploy/rpm</filename> in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. For example, consider <filename>lib32</filename> in a <filename>qemux86-64</filename> image. The possible architectures in the system are "all", "qemux86_64", @@ -4858,7 +4858,7 @@ or <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>) found in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. </para></listitem> </itemizedlist> </para> @@ -4948,7 +4948,7 @@ or <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink> script found in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. </para> <section id='raw-mode'> @@ -5934,7 +5934,7 @@ or <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink> script found in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. You must also be sure of the state of your build in the <link linkend='source-directory'>Source Directory</link>. The following commands run <filename>menuconfig</filename> @@ -6104,7 +6104,7 @@ placed where the OpenEmbedded build system can find and apply them. Syntactically, the configuration statement is identical to what would appear in the <filename>.config</filename> file, which is in the - <link linkend='build-directory'>Build Directory</link>: + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>: <literallayout class='monospaced'> tmp/work/<replaceable>arch</replaceable>-poky-linux/linux-yocto-<replaceable>release_specific_string</replaceable>/linux-<replaceable>arch</replaceable>-<replaceable>build_type</replaceable> </literallayout> @@ -6390,9 +6390,11 @@ machine in a <link linkend='source-directory'>Source Directory</link> named <filename>poky</filename>. - Furthermore, the <link linkend='build-directory'>Build Directory</link> is - <filename>build</filename> and is located in <filename>poky</filename> and - the kernel is based on the Linux 3.4 kernel. + Furthermore, the + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> + is <filename>build</filename> and is located in + <filename>poky</filename> and the kernel is based on the + Linux 3.4 kernel. </para> <para> @@ -6593,7 +6595,7 @@ <listitem><para><emphasis>Build for the correct target architecture:</emphasis> Your selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> definition within the <filename>local.conf</filename> file in the - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> specifies the target architecture used when building the Linux kernel. By default, <filename>MACHINE</filename> is set to <filename>qemux86</filename>, which specifies a 32-bit @@ -6653,7 +6655,7 @@ Never remove any files by hand from the <filename>tmp/deploy</filename> directory inside the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. Always use the various BitBake clean tasks to clear out previous build artifacts. For information on the clean tasks, see the @@ -7018,7 +7020,7 @@ previous bulleted item.</para></listitem> <listitem><para><emphasis>Point to Your distribution configuration file:</emphasis> In your <filename>local.conf</filename> file in the - <link linkend='build-directory'>Build Directory</link>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, set your <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink> variable to point to your distribution's configuration file. @@ -7078,7 +7080,7 @@ <filename>TEMPLATECONF</filename> to locate the directory from which it gathers configuration information that ultimately ends up in the - <link linkend='build-directory'>Build Directory's</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> <filename>conf</filename> directory. By default, <filename>TEMPLATECONF</filename> is set as follows in the <filename>poky</filename> repository: @@ -8031,7 +8033,7 @@ setting <ulink url='&YOCTO_DOCS_REF_URL;#var-PRSERV_HOST'><filename>PRSERV_HOST</filename></ulink> in your <filename>local.conf</filename> file in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>: <literallayout class='monospaced'> PRSERV_HOST = "localhost:0" </literallayout> @@ -8567,7 +8569,7 @@ <listitem><para> Open the <filename>local.conf</filename> file inside your - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> (e.g. <filename>~/poky/build/conf/local.conf</filename>). </para></listitem> <listitem><para> @@ -9025,7 +9027,7 @@ and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> variables to your <filename>local.conf</filename> file, which is found in the - <link linkend='build-directory'>Build Directory</link>: + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>: <literallayout class='monospaced'> DISTRO_FEATURES_append = " ptest" EXTRA_IMAGE_FEATURES += "ptest-pkgs" @@ -9261,8 +9263,8 @@ <para> By default, the OpenEmbedded build system uses the - <link linkend='build-directory'>Build Directory</link> when - building source code. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> + when building source code. The build process involves fetching the source files, unpacking them, and then patching them if necessary before the build takes place. @@ -9626,7 +9628,7 @@ Using either of the following statements in your image recipe or from within the <filename>local.conf</filename> file found in the - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> causes the build system to create a read-only root filesystem: <literallayout class='monospaced'> IMAGE_FEATURES = "read-only-rootfs" @@ -10220,7 +10222,7 @@ <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_IMAGE'><filename>TEST_IMAGE</filename></ulink> variable to "1" in your <filename>local.conf</filename> file in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>: <literallayout class='monospaced'> TEST_IMAGE = "1" </literallayout> @@ -10352,7 +10354,8 @@ $ bitbake <replaceable>image</replaceable> -c testexport </literallayout> Exporting the tests places them in the - <link linkend='build-directory'>Build Directory</link> in + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> + in <filename>tmp/testexport/</filename><replaceable>image</replaceable>, which is controlled by the <filename>TEST_EXPORT_DIR</filename> variable. @@ -11509,7 +11512,7 @@ release just the source as a tarball. You can do this by adding the following to the <filename>local.conf</filename> file found in the - <link linkend='build-directory'>Build Directory</link>: + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>: <literallayout class='monospaced'> INHERIT += "archiver" ARCHIVER_MODE[src] = "original" @@ -11724,7 +11727,7 @@ <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink> class by adding the following statement to the end of your <filename>local.conf</filename> file in your - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. <literallayout class='monospaced'> INHERIT += "report-error" </literallayout> @@ -11783,7 +11786,7 @@ To disable the error reporting feature, simply remove or comment out the following statement from the end of your <filename>local.conf</filename> file in your - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. <literallayout class='monospaced'> INHERIT += "report-error" </literallayout> diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 0782f0acdb..068fd66893 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -87,7 +87,8 @@ <note> For a brief list of terms used when describing the development process in the Yocto Project, - see the "<link linkend='yocto-project-terms'>Yocto Project Terms</link>" section. + see the + "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-terms'>Yocto Project Terms</ulink>" section. </note> <para> @@ -431,8 +432,8 @@ The following figure shows the temporary file structure created on your host system when the build occurs. This - <link linkend='build-directory'>Build Directory</link> contains all the - source files used during the build. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> + contains all the source files used during the build. </para> <para> @@ -478,7 +479,7 @@ </para></listitem> <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>: Temporary kernel source files are kept in the - <link linkend='build-directory'>Build Directory</link> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> created by the OpenEmbedded build system when you run BitBake. If you have never built the kernel in which you are @@ -1270,7 +1271,7 @@ <listitem><para><emphasis>Find the Source Code:</emphasis> Temporary source code used by the OpenEmbedded build system is kept in the - <link linkend='build-directory'>Build Directory</link>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. See the "<link linkend='finding-the-temporary-source-code'>Finding Temporary Source Code</link>" section to learn how to locate the directory that has the @@ -1364,8 +1365,8 @@ experiment a bit to figure out your solution. After you have initially built the package, you can iteratively tweak the source code, which is located in the - <link linkend='build-directory'>Build Directory</link>, and then - you can force a re-compile and quickly test your altered code. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, + and then you can force a re-compile and quickly test your altered code. Once you settle on a solution, you can then preserve your changes in the form of patches. If you are using Quilt for development, see the diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 350c6e49a8..5a3e3ea107 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -526,8 +526,8 @@ <filename>meta/files/common-licenses</filename>. Once the build completes, the list of all licenses found and used during that build are kept in the - <link linkend='build-directory'>Build Directory</link> at - <filename>tmp/deploy/licenses</filename>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> + at <filename>tmp/deploy/licenses</filename>. </para> <para> diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml index 41c18298a5..80e4b24ccb 100644 --- a/documentation/dev-manual/dev-manual-qemu.xml +++ b/documentation/dev-manual/dev-manual-qemu.xml @@ -252,7 +252,7 @@ qemux86" or "qemux86-64". This example starts QEMU with <replaceable>MACHINE</replaceable> set to "qemux86". Assuming a standard - <link linkend='build-directory'>Build Directory</link>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, <filename>runqemu</filename> automatically finds the <filename>bzImage-qemux86.bin</filename> image file and the diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 0e335e28fc..6b97c52ada 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -309,7 +309,7 @@ </para></listitem> <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, which is found in the - <link linkend='build-directory'>Build Directory</link>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, is set up how you want it. This file defines many aspects of the build environment including the target machine architecture through the diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.xml b/documentation/kernel-dev/kernel-dev-maint-appx.xml index 6bb0cf6fd0..7cfcb45c94 100644 --- a/documentation/kernel-dev/kernel-dev-maint-appx.xml +++ b/documentation/kernel-dev/kernel-dev-maint-appx.xml @@ -209,7 +209,7 @@ The files include the final <filename>.config</filename> file, all the <filename>.o</filename> files, the <filename>.a</filename> files, and so forth. Since each machine or BSP has its own separate - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> in its own separate branch of the Git repository, you can easily switch between different builds. </para> diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index c0f1747961..e4a2a022a7 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml @@ -114,7 +114,7 @@ <para> Sourcing the build environment script creates a - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> if one does not already exist. BitBake uses the Build Directory for all its work during builds. The Build Directory has a <filename>conf</filename> directory that @@ -641,7 +641,7 @@ <para> When the OpenEmbedded build system generates an image or an SDK, it gets the packages from a package feed area located in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. The <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> shows this package feeds area in the upper-right corner. @@ -770,7 +770,7 @@ depend on it are re-executed. </note> By default, everything is accomplished in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + <link linkend='build-directory'>Build Directory</link>, which has a defined structure. For additional general information on the Build Directory, see the @@ -1430,7 +1430,7 @@ <para> Images are written out to the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> folder as shown in the figure. This folder contains any files expected to be loaded on the @@ -1545,7 +1545,7 @@ <para> Once built, the SDK installers are written out to the <filename>deploy/sdk</filename> folder inside the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> as shown in the figure at the beginning of this section. Depending on the type of SDK, several variables exist that help configure these files. diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index cdbdd4da24..c4b860b1ce 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml @@ -702,7 +702,8 @@ <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> or <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). - By default, this <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + By default, this + <link linkend='build-directory'>Build Directory</link> is named <filename>build</filename> but can be named anything you want. </para> @@ -765,7 +766,7 @@ <para> Meanwhile, <filename>DESTDIR</filename> is a path within the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. However, when the recipe builds a native program (i.e. one that is intended to run on the build machine), that program is never installed directly to the build machine's root diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index deaac033a3..7f6729db55 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -953,7 +953,7 @@ <filename>.sh</filename> file that installs the tools in the <filename>tmp/deploy/sdk</filename> subdirectory of the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. The installer file has the string "buildtools" in the name. </para></listitem> diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 0513b219cd..5c700bc5ea 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -821,7 +821,7 @@ <listitem><para> When buildhistory is enabled, its output is now written under the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> rather than <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>. Doing so makes it easier to delete diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 2b5cb88efd..472215c25a 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -2393,7 +2393,7 @@ This check was removed for YP 2.3 release <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> variable defined in your <filename>conf/local.conf</filename> configuration file, which is located in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. When defining the variable, you can specify one or more package types. Since images are generated from packages, a packaging class is needed to enable image generation. @@ -2988,7 +2988,7 @@ This check was removed for YP 2.3 release as the build progresses, you can enable <filename>rm_work</filename> by adding the following to your <filename>local.conf</filename> file, which is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. <literallayout class='monospaced'> INHERIT += "rm_work" </literallayout> diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml index 99d5a52a0f..64db00e714 100644 --- a/documentation/ref-manual/ref-devtool-reference.xml +++ b/documentation/ref-manual/ref-devtool-reference.xml @@ -573,7 +573,7 @@ <para> Use the <filename>devtool create-workspace</filename> command to create a new workspace layer in your - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. When you create a new workspace layer, it is populated with the <filename>README</filename> file and the <filename>conf</filename> directory only. diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index b0c4bfeaa4..424b8cc003 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -75,7 +75,8 @@ This directory contains user configuration files and the output generated by the OpenEmbedded build system in its standard configuration where the source tree is combined with the output. - The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + The + <link linkend='build-directory'>Build Directory</link> is created initially when you <filename>source</filename> the OpenEmbedded build environment setup script (i.e. @@ -212,7 +213,7 @@ <para> When you run this script, your Yocto Project environment is set up, a - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> is created, your working directory becomes the Build Directory, and you are presented with a list of common BitBake targets. Here is an example: @@ -246,7 +247,7 @@ <para> By default, running this script without a - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> argument creates the <filename>build</filename> directory in your current working directory. If you provide a Build Directory argument when you @@ -330,7 +331,7 @@ <listitem><para> The script's parameters are positionally dependent. Consequently, you cannot run the script and provide a - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> name without also providing a port number. In other words, the following syntax is illegal: <literallayout class='monospaced'> @@ -386,7 +387,7 @@ <para> By default, running this script without a - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> argument creates a build directory named <filename>build</filename>. If you provide a Build Directory argument and port number when you @@ -443,7 +444,7 @@ <para> The OpenEmbedded build system creates the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> when you run one of the build environment setup scripts (i.e. <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> or diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index bd9e517246..da4da8550d 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -536,7 +536,7 @@ <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory within the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> in which the OpenEmbedded build system places generated objects during a recipe's build process. By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> @@ -734,7 +734,7 @@ variable to "1", "yes", or "true" in your <filename>local.conf</filename> file, which is located in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <link linkend='build-directory'>Build Directory</link>: Here is an example: <literallayout class='monospaced'> BB_DANGLINGAPPENDS_WARNONLY = "1" @@ -759,7 +759,7 @@ Disk space monitoring is disabled by default. To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> variable to your <filename>conf/local.conf</filename> file found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. Use the following form: <literallayout class='monospaced'> BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]" @@ -852,7 +852,7 @@ Defines the disk space and free inode warning intervals. To set these intervals, define the variable in your <filename>conf/local.conf</filename> file in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. </para> <para> @@ -936,7 +936,7 @@ </literallayout> Set this variable in your <filename>local.conf</filename> file in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. </para> </glossdef> </glossentry> @@ -1154,7 +1154,8 @@ <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists the layers to enable during the build. This variable is defined in the <filename>bblayers.conf</filename> configuration - file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + file in the + <link linkend='build-directory'>Build Directory</link>. Here is an example: <literallayout class='monospaced'> BBLAYERS = " \ @@ -1250,7 +1251,7 @@ BBMULTIFONFIG = "configA configB configC" </literallayout> Each configuration file you use must reside in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory's</ulink> + <link linkend='build-directory'>Build Directory</link> <filename>conf/multiconfig</filename> directory (e.g. <replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>). @@ -1280,7 +1281,7 @@ <filename>PATH</filename> variable. <note> If you run BitBake from a directory outside of the - <ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>, + <link linkend='build-directory'>Build Directory</link>, you must be sure to set <filename>BBPATH</filename> to point to the Build Directory. @@ -1626,7 +1627,7 @@ <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the location of the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. You can define this directory indirectly through the <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> and @@ -2595,7 +2596,7 @@ You should only set this variable in the <filename>local.conf</filename> configuration file found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. </para> <para> @@ -2805,7 +2806,8 @@ <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The destination directory. - The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + The location in the + <link linkend='build-directory'>Build Directory</link> where components are installed by the <link linkend='ref-tasks-install'><filename>do_install</filename></link> task. @@ -3116,7 +3118,7 @@ system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system. By default, this directory resides within the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> as <filename>${TMPDIR}/deploy</filename>. </para> @@ -3189,7 +3191,7 @@ The directory is machine-specific as it contains the <filename>${MACHINE}</filename> name. By default, this directory resides within the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>. </para> @@ -3794,7 +3796,7 @@ to touch it. By default, the directory is <filename>downloads</filename> in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. <literallayout class='monospaced'> #DL_DIR ?= "${TOPDIR}/downloads" </literallayout> @@ -4191,7 +4193,7 @@ <para> Typically, you configure this variable in your <filename>local.conf</filename> file, which is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. Although you can use this variable from within a recipe, best practices dictate that you do not. <note> @@ -4761,7 +4763,7 @@ <para> You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the <filename>conf/local.conf</filename> file, which is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to + <link linkend='build-directory'>Build Directory</link>, to point to your custom <filename>fs-perms.txt</filename>. You can specify more than a single file permissions setting table. The paths you specify to these files must be defined within the @@ -5613,7 +5615,7 @@ Typically, you configure this variable in an image recipe. Although you can use this variable from your <filename>local.conf</filename> file, which is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + <link linkend='build-directory'>Build Directory</link>, best practices dictate that you do not. <note> To enable extra features from outside the image recipe, @@ -6562,7 +6564,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The combined binary is deposited into the <filename>tmp/deploy</filename> directory, which is part of the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. </para> <para> @@ -7941,7 +7943,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Specifies the target device for which the image is built. You define <filename>MACHINE</filename> in the <filename>local.conf</filename> file found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. By default, <filename>MACHINE</filename> is set to "qemux86", which is an x86-based architecture machine to be emulated using QEMU: @@ -9085,7 +9087,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This variable, which is set in the <filename>local.conf</filename> configuration file found in the <filename>conf</filename> folder of the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + <link linkend='build-directory'>Build Directory</link>, specifies the package manager the OpenEmbedded build system uses when packaging data. </para> @@ -10531,7 +10533,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" build system to attempt before any others by adding something like the following to the <filename>local.conf</filename> configuration file in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <link linkend='build-directory'>Build Directory</link>: <literallayout class='monospaced'> PREMIRRORS_prepend = "\ git://.*/.* http://www.yoctoproject.org/sources/ \n \ @@ -11493,7 +11495,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> where unpacked recipe source code resides. By default, this directory is <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/${</filename><link linkend='var-BPN'><filename>BPN</filename></link><filename>}-${</filename><link linkend='var-PV'><filename>PV</filename></link><filename>}</filename>, @@ -12411,7 +12413,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" To enable file removal, set the variable to "1" in your <filename>conf/local.conf</filename> configuration file in your: - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. <literallayout class='monospaced'> SKIP_FILEDEPS = "1" </literallayout> @@ -14263,7 +14265,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The suffix identifies the <filename>libc</filename> variant for building. When you are building for multiple variants with the same - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + <link linkend='build-directory'>Build Directory</link>, this mechanism ensures that output for different <filename>libc</filename> variants is kept separate to avoid potential conflicts. @@ -14421,7 +14423,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <filename>ssh</filename>. You can set this variable to "1" in your <filename>local.conf</filename> file in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> to have the OpenEmbedded build system automatically run these tests after an image successfully builds: <literallayout class='monospaced'> @@ -14789,7 +14791,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" files (other than the shared state cache). By default, the <filename>TMPDIR</filename> variable points to <filename>tmp</filename> within the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. </para> <para> @@ -14924,7 +14926,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The top-level - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. BitBake automatically sets this variable when you initialize your build environment using either <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 0c949880e7..b2f1048f2e 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml @@ -172,7 +172,7 @@ distribution configuration options, compiler tuning options, general common configuration options, and user configuration options in <filename>local.conf</filename>, which is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. </para> </section> </section> @@ -562,7 +562,7 @@ code. However, there is still the question of a task's indirect inputs - the things that were already built and present in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <link linkend='build-directory'>Build Directory</link>. The checksum (or signature) for a particular task needs to add the hashes of all the tasks on which the particular task depends. Choosing which dependencies to add is a policy decision. diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index d1ac18fb2f..9fb74172b5 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -56,7 +56,8 @@ <para> The <replaceable>build_dir</replaceable> argument is optional and specifies the directory the OpenEmbedded build system uses for the build - - the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + the + <link linkend='build-directory'>Build Directory</link>. If you do not specify a Build Directory, it defaults to a directory named <filename>build</filename> in your current working directory. A common practice is to use a different Build Directory for different targets. @@ -142,7 +143,7 @@ <para> Once an image has been built, it often needs to be installed. The images and kernels built by the OpenEmbedded build system are placed in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in + <link linkend='build-directory'>Build Directory</link> in <filename class="directory">tmp/deploy/images</filename>. For information on how to run pre-built images such as <filename>qemux86</filename> and <filename>qemuarm</filename>, see the @@ -978,7 +979,7 @@ Removing <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> (usually <filename>tmp/</filename>, within the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>) + <link linkend='build-directory'>Build Directory</link>) can often fix temporary build issues. Removing <filename>TMPDIR</filename> is usually a relatively cheap operation, because task output will be @@ -1101,7 +1102,7 @@ <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> variable to "1" at the end of your <filename>conf/local.conf</filename> file found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <link linkend='build-directory'>Build Directory</link>: <literallayout class='monospaced'> INHERIT += "buildhistory" BUILDHISTORY_COMMIT = "1" @@ -1359,7 +1360,7 @@ you can enable writing only image information without any history by adding the following to your <filename>conf/local.conf</filename> file found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <link linkend='build-directory'>Build Directory</link>: <literallayout class='monospaced'> INHERIT += "buildhistory" BUILDHISTORY_COMMIT = "0" @@ -1645,7 +1646,7 @@ <filename>sync()</filename> calls into the file system on the principle that if there was a significant failure, the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <link linkend='build-directory'>Build Directory</link> contents could easily be rebuilt. </para></listitem> <listitem><para> diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml index 965cccc2ca..1317a79ea8 100644 --- a/documentation/sdk-manual/sdk-appendix-customizing.xml +++ b/documentation/sdk-manual/sdk-appendix-customizing.xml @@ -289,7 +289,7 @@ for the SDK alone, create a <filename>conf/sdk-extra.conf</filename> either in your - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> or within any layer and put your <filename>SSTATE_MIRRORS</filename> setting within that file. diff --git a/documentation/sdk-manual/sdk-appendix-mars.xml b/documentation/sdk-manual/sdk-appendix-mars.xml index 9957057e99..d960b1009d 100644 --- a/documentation/sdk-manual/sdk-appendix-mars.xml +++ b/documentation/sdk-manual/sdk-appendix-mars.xml @@ -392,7 +392,7 @@ <filename>Build System Derived Toolchain:</filename></emphasis> Select this type if you built the toolchain as part of the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. When you select <filename>Build system derived toolchain</filename>, you are using the toolchain built and @@ -418,7 +418,7 @@ toolchain, the path you provide for the <filename>Toolchain Root Location</filename> field is the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> from which you run the <filename>bitbake</filename> command (e.g <filename>/home/scottrif/poky/build</filename>).</para> @@ -438,7 +438,7 @@ <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. If so, the <filename>MY_QEMU_ROOTFS</filename> directory is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> and you would browse to and select that directory (e.g. <filename>/home/scottrif/build/MY_QEMU_ROOTFS</filename>). </para> @@ -487,7 +487,7 @@ <filename>Build system derived toolchain</filename>, the target kernel you built will be located in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> in <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> directory. diff --git a/documentation/sdk-manual/sdk-intro.xml b/documentation/sdk-manual/sdk-intro.xml index 68401690de..47b9bc7ba1 100644 --- a/documentation/sdk-manual/sdk-intro.xml +++ b/documentation/sdk-manual/sdk-intro.xml @@ -215,7 +215,7 @@ built-in <filename>devtool</filename> functionality. This toolchain is created by running a SDK installer script or through a - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> that is based on your Metadata configuration or extension for your targeted device. The cross-toolchain works with a matching target sysroot. diff --git a/documentation/sdk-manual/sdk-working-projects.xml b/documentation/sdk-manual/sdk-working-projects.xml index 54bc4d739d..526d9208a3 100644 --- a/documentation/sdk-manual/sdk-working-projects.xml +++ b/documentation/sdk-manual/sdk-working-projects.xml @@ -894,7 +894,7 @@ </emphasis> Select this type if you built the toolchain as part of the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. When you select <filename>Build system derived toolchain</filename>, you are using the toolchain built @@ -925,7 +925,7 @@ the <filename>Toolchain Root Location</filename> field is the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> from which you run the <filename>bitbake</filename> command (e.g <filename>/home/scottrif/poky/build</filename>). @@ -949,7 +949,7 @@ If so, the <filename>MY_QEMU_ROOTFS</filename> directory is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> and you would browse to and select that directory (e.g. <filename>/home/scottrif/poky/build/MY_QEMU_ROOTFS</filename>). @@ -1003,7 +1003,7 @@ <filename>Build system derived toolchain</filename>, the target kernel you built will be located in the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> in <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> directory. diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml index 3a46b61b73..9bd6127f3c 100644 --- a/documentation/toaster-manual/toaster-manual-reference.xml +++ b/documentation/toaster-manual/toaster-manual-reference.xml @@ -879,7 +879,7 @@ When using <filename>manage.py</filename> commands given a default configuration, you must be sure that your working directory is set to the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. Using <filename>manage.py</filename> commands from the Build Directory allows Toaster to find the <filename>toaster.sqlite</filename> file, which is located diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml index 966c35d4d3..77291c1eea 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml @@ -145,7 +145,7 @@ <listitem><para> From the directory containing the Toaster database, which by default is the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, invoke the <filename>createsuperuser</filename> command from <filename>manage.py</filename>: <literallayout class='monospaced'> @@ -378,7 +378,7 @@ <para> This line also runs the <filename>checksettings</filename> command, which configures the location of the Toaster - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build directory</ulink>. + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build directory</ulink>. The Toaster root directory <filename>TOASTER_DIR</filename> determines where the Toaster build directory is created on the file system. diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 5b64e0f6fe..1d9bd9f2e8 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -528,7 +528,7 @@ $ source &OE_INIT_FILE; </literallayout> Among other things, the script creates the - <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, which is <filename>build</filename> in this case and is located in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |