diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-start.xml')
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 53 |
1 files changed, 28 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 53db4da..fbebe4d 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.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-start'> @@ -9,7 +10,7 @@ This chapter introduces the Yocto Project and gives you an idea of what you need to get started. You can find enough information to set up your development host and build or use images for hardware supported by the Yocto Project by reading - <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'> + <ulink url='&YOCTO_DOCS_QS_URL;'> The Yocto Project Quick Start</ulink>. </para> @@ -57,7 +58,7 @@ </para></listitem> <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages exist on your development system (e.g. Python 2.6 or 2.7). - See "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" + See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section in the Yocto Project Quick start for the exact package requirements and the installation commands to install them for the supported distributions.</para></listitem> @@ -75,13 +76,14 @@ <itemizedlist> <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute back into the Yocto Project, you can simply download the Yocto Project release you want - from the website’s <ulink url='http://yoctoproject.org/download'>download page</ulink>. + from the website’s <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink>. Once you have the tarball, just extract it into a directory of your choice.</para> - <para>For example, the following command extracts the Yocto Project 1.1 release tarball + <para>For example, the following command extracts the Yocto Project &DISTRO; + release tarball into the current working directory and sets up the Yocto Project file structure - with a top-level directory named <filename>poky-edison-6.0</filename>: + with a top-level directory named <filename>&YOCTO_POKY;</filename>: <literallayout class='monospaced'> - $ tar xfj poky-edison-6.0.tar.bz2 + $ tar xfj &YOCTO_POKY_TARBALL; </literallayout></para> <para>This method does not produce a Git repository. Instead, you simply end up with a local snapshot of the @@ -100,7 +102,7 @@ <note>The name of the Yocto Project Files Git repository in the Yocto Project Files Source Repositories is <filename>poky</filename>. You can view the Yocto Project Source Repositories at - <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink></note> + <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> The command creates the local repository in a directory named <filename>poky</filename>. For information on Git used within the Yocto Project, see the "<link linkend='git'>Git</link>" section. @@ -111,9 +113,10 @@ remote: Compressing objects: 100% (35987/35987), done. remote: Total 116882 (delta 80651), reused 113045 (delta 77578) Receiving objects: 100% (116882/116882), 72.13 MiB | 2.68 MiB/s, done. - Resolving deltas: 100% (80651/80651), done. </literallayout></para> + Resolving deltas: 100% (80651/80651), done. + </literallayout></para> <para>For another example of how to set up your own local Git repositories, see this - <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> + <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> wiki page</ulink>, which describes how to create both <filename>poky</filename> and <filename>meta-intel</filename> Git repositories.</para></listitem> </itemizedlist></para></listitem> @@ -122,7 +125,7 @@ need to establish local copies of the source. You can find Git repositories of supported Linux Yocto Kernels organized under "Yocto Linux Kernel" in the Yocto Project Source Repositories at - <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.</para> + <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> <para>This setup involves creating a bare clone of the Linux Yocto kernel and then copying that cloned repository. You can create the bare clone and the copy of the bare clone anywhere you like. @@ -164,7 +167,7 @@ source files from upstream each time you make changes to the kernel.</para> <para>You can find the <filename>poky-extras</filename> Git Repository in the "Yocto Metadata Layers" area of the Yocto Project Source Repositories at - <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>. + <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. It is good practice to create this Git repository inside the Yocto Project files Git repository.</para> <para>Following is an example that creates the <filename>poky-extras</filename> Git @@ -185,7 +188,7 @@ The Yocto Project provides a layer called <filename>meta-intel</filename> and it is maintained in its own separate Git repository. The <filename>meta-intel</filename> layer contains many supported - <ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>.</para> + <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>.</para> <para>Similar considerations exist for setting up the <filename>meta-intel</filename> layer. You can get set up for BSP development one of two ways: tarball extraction or @@ -204,13 +207,13 @@ meta-n450 </literallayout> See the - "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>" + "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" section in the Yocto Project Board Support Package (BSP) Developer's Guide for more information on BSP Layers. <itemizedlist> <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released BSP tarball from the same - <ulink url='http://yoctoproject.org/download'>download site</ulink> used + <ulink url='&YOCTO_HOME_URL;/download'>download site</ulink> used to get the Yocto Project release. Once you have the tarball, just extract it into a directory of your choice. Again, this method just produces a snapshot of the BSP layer in the form @@ -220,7 +223,7 @@ to set up the <filename>meta-intel</filename> Git repository. You can locate the <filename>meta-intel</filename> Git repository in the "Yocto Metadata Layers" area of the Yocto Project Source Repositories at - <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.</para> + <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside the Yocto Project Files Git repository. For example, the following transcript shows the steps to clone the @@ -237,7 +240,7 @@ Resolving deltas: 100% (546/546), done. </literallayout></para> <para>The same - <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> + <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> wiki page</ulink> referenced earlier covers how to set up the <filename>meta-intel</filename> Git repository.</para></listitem> </itemizedlist></para></listitem> @@ -245,7 +248,7 @@ applications using the Eclipse Integrated Development Environment (IDE), you will need this plug-in. See the - "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</ulink>" + "<ulink url='&YOCTO_DOCS_ADT_URL;#setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</ulink>" section in the Yocto Application Development Toolkit (ADT) User’s Guide for more information.</para></listitem> </itemizedlist> @@ -258,7 +261,7 @@ <para> The build process creates an entire Linux distribution, including the toolchain, from source. For more information on this topic, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section in the Yocto Project Quick Start. </para> @@ -275,15 +278,15 @@ is set up how you want it. This file defines many aspects of the build environment including the target machine architecture through the - <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable, + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, the development machine's processor use through the - <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and - <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and a centralized tarball download directory through the - <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> <listitem><para>Build the image using the <filename>bitbake</filename> command. If you want information on BitBake, see the user manual at - <ulink url='http://docs.openembedded.org/bitbake/html'></ulink>.</para></listitem> + <ulink url='&OE_DOCS_URL;/bitbake/html'></ulink>.</para></listitem> <listitem><para>Run the image either on the actual hardware or using the QEMU emulator.</para></listitem> </orderedlist> @@ -305,7 +308,7 @@ <para> You can find details on all these steps in 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>" + "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" section of the Yocto Project Quick Start. </para> </section> |
