diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-10-16 15:23:00 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-10-30 15:55:06 +0000 |
commit | 04e72f020c468cd48f6d41154f6a60403207729e (patch) | |
tree | 9e35f90c595909adcaebf8c25ce2006baadde1f4 /documentation/ref-manual/ref-structure.xml | |
parent | e42ddecaf0b18ea2872be86025f377841fb719bf (diff) | |
download | openembedded-core-contrib-04e72f020c468cd48f6d41154f6a60403207729e.tar.gz |
ref-manual: Converted external links to internal and fixed dev-manual links
The title of the dev-manual changed to the Yocto Project Development
Tasks Manual. I added that to the links. Also fixed several external
links that really should have been internal.
(From yocto-docs rev: ff2d0010530d6969b2ffd64e6d23c79a18d7f368)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-structure.xml')
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 39 |
1 files changed, 21 insertions, 18 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index e1c6ee0a8b..72834fd17c 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -7,17 +7,19 @@ <title>Source Directory Structure</title> <para> - The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components. - Understanding them and knowing where they are located is key to using the Yocto Project well. - This chapter describes the Source Directory and gives information about the various - files and directories. + The <link linkend='source-directory'>Source Directory</link> + consists of several components. + Understanding them and knowing where they are located is key to using the + Yocto Project well. + This chapter describes the Source Directory and gives information about + the various files and directories. </para> <para> For information on how to establish a local Source Directory on your development system, see the "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-yocto-project-source-files'>Working With Yocto Project Source Files</ulink>" - section in the Yocto Project Development Manual. + section in the Yocto Project Development Tasks Manual. </para> <note> @@ -32,7 +34,7 @@ <para> This section describes the top-level components of the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + <link linkend='source-directory'>Source Directory</link>. </para> <section id='structure-core-bitbake'> @@ -43,7 +45,7 @@ The copy usually matches the current stable BitBake release from the BitBake project. BitBake, a - <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink> + <link linkend='metadata'>Metadata</link> interpreter, reads the Yocto Project Metadata and runs the tasks defined by that data. Failures are usually from the Metadata and not from BitBake itself. @@ -85,7 +87,7 @@ <para> It is also possible to place output and configuration files in a directory separate from the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + <link linkend='source-directory'>Source Directory</link> by providing a directory name when you <filename>source</filename> the setup script. For information on separating output from your local @@ -221,13 +223,13 @@ The script gets its default list of common targets from the <filename>conf-notes.txt</filename> file, which is found in the <filename>meta-poky</filename> directory within the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + <link linkend='source-directory'>Source Directory</link>. Should you have custom distributions, it is very easy to modify this configuration file to include your targets for your distribution. See the "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" - section in the Yocto Project Development Manual for more + section in the Yocto Project Development Tasks Manual for more information. </para> @@ -241,17 +243,17 @@ build system to create a Build Directory of your choice. For example, the following command creates a Build Directory named <filename>mybuilds</filename> that is outside of the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: + <link linkend='source-directory'>Source Directory</link>: <literallayout class='monospaced'> $ source &OE_INIT_FILE; ~/mybuilds </literallayout> The OpenEmbedded build system uses the template configuration files, which are found by default in the <filename>meta-poky/conf</filename> directory in the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + Source Directory. See the "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" - section in the Yocto Project Development Manual for more + section in the Yocto Project Development Tasks Manual for more information. <note> The OpenEmbedded build system does not support file or directory names that @@ -365,7 +367,7 @@ You can see how the <filename>TEMPLATECONF</filename> variable is used by looking at the <filename>scripts/oe-setup-builddir</filename> script in the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + <link linkend='source-directory'>Source Directory</link>. You can find the Yocto Project version of the <filename>local.conf.sample</filename> file in the <filename>meta-poky/conf</filename> directory. @@ -415,7 +417,7 @@ <note> You can see how the <filename>TEMPLATECONF</filename> variable <filename>scripts/oe-setup-builddir</filename> script in the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + <link linkend='source-directory'>Source Directory</link>. You can find the Yocto Project version of the <filename>bblayers.conf.sample</filename> file in the <filename>meta-poky/conf</filename> directory. @@ -563,7 +565,7 @@ contain appropriate <filename>COPYING</filename> license files with other licensing information. For information on licensing, see the "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" - section. + section in the Yocto Project Development Tasks Manual. </para> </section> @@ -738,7 +740,8 @@ <filename>linux-qemux86-standard-build</filename> and then patched by Quilt. (See the "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using Quilt in Your Workflow</ulink>" - section in the Yocto Project Development Manual for more information.) + section in the Yocto Project Development Tasks Manual for more + information.) Within the <filename>linux-qemux86-standard-build</filename> directory, standard Quilt directories <filename>linux-3.0/patches</filename> and <filename>linux-3.0/.pc</filename> are created, @@ -872,7 +875,7 @@ <para> As mentioned previously, - <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink> is the core + <link linkend='metadata'>Metadata</link> is the core of the Yocto Project. Metadata has several important subdivisions: </para> |