diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-model.xml')
| -rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 77 |
1 files changed, 41 insertions, 36 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 9be8673..46adc97 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -1,5 +1,6 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <chapter id='dev-manual-model'> @@ -24,7 +25,7 @@ For a user-space application development example that uses the <trademark class='trade'>Eclipse</trademark> IDE, see the - <ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html'> + <ulink url='&YOCTO_DOCS_ADT_URL;'> The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>. </para> @@ -79,8 +80,9 @@ <orderedlist> <listitem><para><emphasis>Set up your host development system to support development using the Yocto Project</emphasis>: See the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#the-linux-distro'>The Linux Distributions</ulink>" and the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" sections both + "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" + and the + "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both in the Yocto Project Quick Start for requirements.</para></listitem> <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your system</emphasis>: You need to have the Yocto Project files available on your host system. @@ -112,7 +114,7 @@ Embedded Media Graphics Driver (EMGD). The remainder of this example uses that base BSP.</para> <para>To see the supported BSPs, go to the Yocto Project - <ulink url='http://www.yoctoproject.org/download'>download page</ulink> and click + <ulink url='&YOCTO_DL_URL;/download'>download page</ulink> and click on “BSP Downloads.”</para></listitem> <listitem><para><emphasis>Create your own BSP layer</emphasis>: Layers are ideal for isolating and storing work for a given piece of hardware. @@ -137,16 +139,17 @@ N450, and Sugar Bay are isolated.</note> <para>When you set up a layer for a new BSP, you should follow a standard layout. This layout is described in the section - "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-filelayout'>Example Filesystem Layout</ulink>" section of the Board Support Package (BSP) Development Guide. + "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout'>Example Filesystem Layout</ulink>" + section of the Board Support Package (BSP) Development Guide. In the standard layout, you will notice a suggested structure for recipes and configuration information. You can see the standard layout for the Crown Bay BSP in this example by examining the directory structure of the <filename>meta-crownbay</filename> layer inside the local Yocto Project files.</para></listitem> <listitem><para><emphasis>Make configuration changes to your new BSP - layer</emphasis>: The standard BSP layer structure organizes the files you need to edit in - <filename>conf</filename> and several <filename>recipes-*</filename> directories within the - BSP layer. + layer</emphasis>: The standard BSP layer structure organizes the files you need + to edit in <filename>conf</filename> and several <filename>recipes-*</filename> + directories within the BSP layer. Configuration changes identify where your new layer is on the local system and identify which kernel you are going to use. </para></listitem> @@ -160,7 +163,8 @@ You need to get the build environment ready by sourcing an environment setup script and you need to be sure two key configuration files are configured appropriately.</para> <para>The entire process for building an image is overviewed in the section - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" section of the Yocto Project Quick Start. + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section + of the Yocto Project Quick Start. You might want to reference this information.</para></listitem> <listitem><para><emphasis>Build the image</emphasis>: The Yocto Project uses the BitBake tool to build images based on the type of image you want to create. @@ -168,7 +172,7 @@ <ulink url='http://bitbake.berlios.de/manual/'>here</ulink>.</para> <para>The build process supports several types of images to satisfy different needs. See the - "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" appendix + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in The Yocto Project Reference Manual for information on supported images.</para></listitem> </orderedlist> @@ -178,10 +182,10 @@ You can view a video presentation on "Building Custom Embedded Images with Yocto" at <ulink url='http://free-electrons.com/blog/elc-2011-videos'>Free Electrons</ulink>. You can also find supplemental information in - <ulink url='http://yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html'> + <ulink url='&YOCTO_DOCS_BSP_URL;'> The Board Support Package (BSP) Development Guide</ulink>. Finally, there is wiki page write up of the example also located - <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'> + <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'> here</ulink> that you might find helpful. </para> </section> @@ -201,7 +205,7 @@ The remainder of this section presents a high-level overview of the Linux Yocto kernel architecture and the steps to modify the Linux Yocto kernel. For a complete discussion of the kernel, see - <ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html'> + <ulink url='&YOCTO_DOCS_KERNEL_URL;'> The Yocto Project Kernel Architecture and Use Manual</ulink>. You can reference the appendix "<link linkend='dev-manual-kernel-appendix'>Kernel Modification Example</link>" @@ -221,7 +225,7 @@ <para> You can find a web interface to the Linux Yocto kernel source repositories at - <ulink url='http://git.yoctoproject.org/'></ulink>. + <ulink url='&YOCTO_GIT_URL;'></ulink>. If you look at the interface, you will see to the left a grouping of Git repositories titled "Yocto Linux Kernel." Within this group, you will find the four different kernels supported by @@ -352,7 +356,7 @@ <para> Again, for a complete discussion of the Yocto Project kernel's architcture and its branching strategy, - see the <ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html'> + see the <ulink url='&YOCTO_DOCS_KERNEL_URL;'> The Yocto Project Kernel Architecture and Use Manual</ulink>. Also, you can reference <xref linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source Code</xref> @@ -376,8 +380,8 @@ <orderedlist> <listitem><para><emphasis>Set up your host development system to support development using the Yocto Project</emphasis>: See - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#the-linux-distro'>The Linux Distributions</ulink>" and - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" sections both + "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and + "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both in the Yocto Project Quick Start for requirements.</para></listitem> <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your system</emphasis>: Having the Yocto Project files on your system gives you access to @@ -457,7 +461,8 @@ (<filename>local.conf</filename> and <filename>bblayers.conf</filename>) are configured appropriately.</para> <para>The entire process for building an image is overviewed in the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" section of the Yocto Project Quick Start. + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" + section of the Yocto Project Quick Start. You might want to reference this information. Also, you should look at the detailed examples found in the appendices at at the end of this manual.</para></listitem> @@ -468,7 +473,7 @@ <ulink url='http://bitbake.berlios.de/manual/'>here</ulink>.</para> <para>The build process supports several types of images to satisfy different needs. See the appendix - "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" in + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" in The Yocto Project Reference Manual for information on supported images.</para></listitem> <listitem><para><emphasis>Make your configuration changes available in the kernel layer</emphasis>: Up to this point, all the configuration changes to the @@ -519,7 +524,7 @@ provides an overview of the general development process. If you want to see a detailed example of the process as it is used from within the Eclipse IDE, see - <ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html'> + <ulink url='&YOCTO_DOCS_ADT_URL;'> The Application Development Toolkit (ADT) User's Manual</ulink>. </para> @@ -536,8 +541,8 @@ <orderedlist> <listitem><para><emphasis>Prepare the Host System for the Yocto Project</emphasis>: See - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#the-linux-distro'>The Linux Distributions</ulink>" and - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" sections both + "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and + "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both in the Yocto Project Quick Start for requirements.</para></listitem> <!-- @@ -565,12 +570,12 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the (QEMU or real hardware), the area you get the image from differs. <itemizedlist> <listitem><para>Download the image from - <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/'> + <ulink url='&YOCTO_MACHINES_DL_URL;'> <filename>machines</filename></ulink> if your target architecture is supported and you are going to develop and test your application on actual hardware. </para></listitem> <listitem><para>Download the image from the - <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/qemu/'> + <ulink url='&YOCTO_QEMU_DL_URL;'> <filename>machines/qemu</filename></ulink> if your target architecture is supported and you are going to develop and test your application using the QEMU emulator.</para></listitem> @@ -585,10 +590,8 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the </itemizedlist></para> <para>For information on pre-built kernel image naming schemes for images that can run on the QEMU emulator, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" - section in - <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'> - The Yocto Project Quick Start</ulink>.</para></listitem> + "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" + section in the Yocto Project Quick Start.</para></listitem> <listitem><para><emphasis>Install the ADT</emphasis>: The ADT provides a target-specific cross-development toolchain, the root filesystem, the QEMU emulator, and other tools that can help you develop your application. @@ -596,8 +599,9 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the easy method. You can get these pieces by running an ADT installer script, which is configurable. For information on how to install the ADT, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#using-the-adt-installer'>Using the ADT Installer</ulink>" section - in The Yocto Project Application Development (ADT) User's Manual.</para></listitem> + "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Using the ADT Installer</ulink>" + section + in the Yocto Project Application Development (ADT) User's Manual.</para></listitem> <listitem><para><emphasis>If Applicable, Secure the Target Root Filesystem</emphasis>: If you choose not to install the ADT using the ADT Installer, you need to find and download the @@ -641,13 +645,14 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the <orderedlist> <listitem><para><emphasis>Install the cross-development toolchain for your target hardware:</emphasis> For information on how to install the toolchain, see the - "<ulink url='http://www.yoctoproject/docs/1.1/adt-manual/adt-manual.html#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" section - in The Yocto Project Application Development (ADT) User's Manual.</para></listitem> + "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" + section + in the Yocto Project Application Development (ADT) User's Manual.</para></listitem> <listitem><para><emphasis>Download the Target Image:</emphasis> The Yocto Project supports several target architectures and has many pre-built kernel images and root filesystem images.</para> <para>If you are going to develop your application on hardware, go to the - <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/'> + <ulink url='&YOCTO_MACHINES_DL_URL;'> <filename>machines</filename></ulink> download area and choose a target machine area from which to download the kernel image and root filesystem. This download area could have several files in it that support development using @@ -657,7 +662,7 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the Be sure to get the files you need for your particular development process.</para> <para>If you are going to develop your application and then run and test it using the QEMU emulator, go to the - <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/qemu/'> + <ulink url='&YOCTO_QEMU_DL_URL;'> <filename>machines/qemu</filename></ulink> download area. From this area, go down into the directory for your target architecture (e.g. <filename>qemux86_64</filename> for an @@ -665,7 +670,7 @@ WRITER NOTE: The areas to get the kernel and root filesystem are located in the Download kernel, root filesystem, and any other files you need for your process. <note>In order to use the root filesystem in QEMU, you need to extract it. See the - "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>" section for information on how to extract the + "<ulink url='&YOCTO_DOCS_ADT_URL;#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>" section for information on how to extract the root filesystem.</note></para></listitem> <listitem><para><emphasis>Develop and Test your Application:</emphasis> At this point, you have the tools to develop your application. |
