sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual: Fixed broken structure. 

I discovered that the dev-manual was not making correctly.
Probably resulted in trying to merge in some of Robert P. J. Day's
comments.  I have made the tag changes to fix this.  Also,
I added back in the two methods for setting up meta-intel
as I am not making the tarball-exclusion changes to the dora
branch.

(From yocto-docs rev: a10a9c3960045a777da6245a2502504f15fad579)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-11-12 11:22:10 -08:00 committed by Richard Purdie
parent 5de0010aff
commit 184166fa7a
1 changed files with 86 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

136
documentation/dev-manual/dev-manual-start.xml
View File

@ -57,8 +57,8 @@
<para> <para>
Here is what you need to use the Yocto Project: Here is what you need to use the Yocto Project:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current <listitem><para><emphasis>Host System:</emphasis>
Linux-based host system. You should have a reasonably current Linux-based host system.
You will have the best results with a recent release of Fedora, You will have the best results with a recent release of Fedora,
openSUSE, Debian, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project openSUSE, Debian, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project
and officially supported. and officially supported.
@ -69,15 +69,15 @@
<para> <para>
You should also have about 100 gigabytes of free disk space for building images. You should also have about 100 gigabytes of free disk space for building images.
</para></listitem> </para></listitem>
<listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system <listitem><para><emphasis>Packages:</emphasis>
requires that certain packages exist on your development system (e.g. Python 2.6 or 2.7). The OpenEmbedded build system requires that certain packages
exist on your development system (e.g. Python 2.6 or 2.7).
See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>"
section in the Yocto Project Quick Start and the section in the Yocto Project Quick Start and the
"<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
section in the Yocto Project Reference Manual for the exact section in the Yocto Project Reference Manual for the exact
package requirements and the installation commands to install package requirements and the installation commands to install
them for the supported distributions. them for the supported distributions.</para></listitem>
</para></listitem>
<listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis>
You need a release of the Yocto Project installed locally on You need a release of the Yocto Project installed locally on
your development system. your development system.
@ -86,7 +86,8 @@
and is created when you use and is created when you use
<link linkend='git'>Git</link> to clone a local copy <link linkend='git'>Git</link> to clone a local copy
of the upstream <filename>poky</filename> repository, of the upstream <filename>poky</filename> repository,
or when you download an official release of the corresponding tarball.</para> or when you download an official release of the corresponding
tarball.</para>
<para>Working from a copy of the upstream repository allows you <para>Working from a copy of the upstream repository allows you
to contribute back into the Yocto Project or simply work with to contribute back into the Yocto Project or simply work with
the latest software on a development branch. the latest software on a development branch.
@ -94,7 +95,7 @@
a complete history of changes and you are working with a local a complete history of changes and you are working with a local
clone of that repository, you have access to all the Yocto clone of that repository, you have access to all the Yocto
Project development branches and tag names used in the upstream Project development branches and tag names used in the upstream
repository.</para> repository.
<note>You can view the Yocto Project Source Repositories at <note>You can view the Yocto Project Source Repositories at
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>
</note> </note>
@ -108,27 +109,40 @@
directory of your choice.</para> directory of your choice.</para>
<para>For example, the following command extracts the <para>For example, the following command extracts the
Yocto Project &DISTRO; release tarball Yocto Project &DISTRO; release tarball
into the current working directory and sets up the local Source Directory into the current working directory and sets up the local
with a top-level folder named <filename>&YOCTO_POKY;</filename>: Source Directory
with a top-level folder named
<filename>&YOCTO_POKY;</filename>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ tar xfj &YOCTO_POKY_TARBALL; $ tar xfj &YOCTO_POKY_TARBALL;
</literallayout></para> </literallayout></para>
<para>This method does not produce a local Git repository. <para>This method does not produce a local Git
Instead, you simply end up with a snapshot of the release.</para></listitem> repository.
<listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing Instead, you simply end up with a snapshot of the
back into the Yocto Project or you simply want to keep up release.</para></listitem>
with the latest developments, you should use Git commands to set up a local <listitem><para><emphasis>Git Repository Method:</emphasis>
Git repository of the upstream <filename>poky</filename> source repository. If you are going to be contributing back into the Yocto
Doing so creates a repository with a complete history of changes and allows Project or you simply want to keep up with the latest
you to easily submit your changes upstream to the project. developments, you should use Git commands to set up a
Because you clone the repository, you have access to all the Yocto Project development local Git repository of the upstream
branches and tag names used in the upstream repository.</para> <filename>poky</filename> source repository.
<note>You can view the Yocto Project Source Repositories at Doing so creates a repository with a complete history
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> of changes and allows you to easily submit your changes
<para>The following transcript shows how to clone the <filename>poky</filename> upstream to the project.
Git repository into the current working directory. Because you clone the repository, you have access to all
The command creates the local repository in a directory named <filename>poky</filename>. the Yocto Project development branches and tag names
For information on Git used within the Yocto Project, see the used in the upstream repository.
<note>You can view the Yocto Project Source Repositories
at
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>
</note></para>
<para>The following transcript shows how to clone the
<filename>poky</filename> Git repository into the
current working directory.
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. "<link linkend='git'>Git</link>" section.
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ git clone git://git.yoctoproject.org/poky $ git clone git://git.yoctoproject.org/poky
@ -138,11 +152,14 @@
remote: Total 203728 (delta 147444), reused 202891 (delta 146614) remote: Total 203728 (delta 147444), reused 202891 (delta 146614)
Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done. Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done.
Resolving deltas: 100% (147444/147444), done. Resolving deltas: 100% (147444/147444), done.
</literallayout></para> </literallayout>
<para>For another example of how to set up your own local Git repositories, see this For another example of how to set up your own local
<ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> Git repositories, see this
wiki page</ulink>, which describes how to create both <filename>poky</filename> <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink>,
and <filename>meta-intel</filename> Git repositories.</para></listitem> which describes how to create both
<filename>poky</filename> and
<filename>meta-intel</filename> Git repositories.
</para></listitem>
</itemizedlist></para></listitem> </itemizedlist></para></listitem>
<listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis>
If you are going to be making modifications to a supported Yocto Project kernel, you If you are going to be making modifications to a supported Yocto Project kernel, you
@ -166,7 +183,7 @@
<filename>linux-yocto-3.10.git</filename>, while the <filename>linux-yocto-3.10.git</filename>, while the
copy is named <filename>my-linux-yocto-3.10-work</filename>: copy is named <filename>my-linux-yocto-3.10-work</filename>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ git clone --bare git://git.yoctoproject.org/linux-yocto-3.10 linux-yocto-3.10.git $ git clone &dash;&dash;bare git://git.yoctoproject.org/linux-yocto-3.10 linux-yocto-3.10.git
Cloning into bare repository 'linux-yocto-3.10.git'... Cloning into bare repository 'linux-yocto-3.10.git'...
remote: Counting objects: 3364487, done. remote: Counting objects: 3364487, done.
remote: Compressing objects: 100% (507178/507178), done. remote: Compressing objects: 100% (507178/507178), done.
@ -233,20 +250,39 @@
See the See the
"<ulink url='&YOCTO_DOCS_BSP_URL;#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) section in the Yocto Project Board Support Package (BSP)
Developer's Guide for more information on BSP Layers.</para> Developer's Guide for more information on BSP Layers.
<para>You can locate the <filename>meta-intel</filename> Git <itemizedlist>
repository in the "Yocto Metadata Layers" area of the Yocto <listitem><para><emphasis>Tarball Extraction:</emphasis>
Project Source Repositories at You can download any released BSP tarball from the same
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> "Downloads" page of the Yocto Project
<para>Using <ulink url='https://www.yoctoproject.org/downloads'>Website</ulink>
<link linkend='git'>Git</link> to create a local clone of the to get the Yocto Project release.
upstream repository can be helpful if you are working with Once on the "Download" page, look to the right of the
BSPs. page and scroll down to find the BSP tarballs.</para>
Typically, you set up the <filename>meta-intel</filename> <para>Once you have the tarball, just extract it into a
Git repository inside the Source Directory. directory of your choice.
For example, the following transcript shows the steps to clone Again, this method just produces a snapshot of the BSP
<filename>meta-intel</filename>. layer in the form of a hierarchical directory
<literallayout class='monospaced'> structure.</para></listitem>
<listitem><para><emphasis>Git Repository Method:</emphasis>
If you are working with a local Git repository for your
Source Directory, you should also use this method 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='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
<para>Using
<link linkend='git'>Git</link> to create a local clone
of the upstream repository can be helpful if you are
working with BSPs.
Typically, you set up the
<filename>meta-intel</filename> Git repository inside
the Source Directory.
For example, the following transcript shows the steps
to clone <filename>meta-intel</filename>.
<literallayout class='monospaced'>
$ cd ~/poky $ cd ~/poky
$ git clone git://git.yoctoproject.org/meta-intel.git $ git clone git://git.yoctoproject.org/meta-intel.git
Cloning into 'meta-intel'... Cloning into 'meta-intel'...
@ -255,12 +291,12 @@
remote: Total 7366 (delta 3997), reused 7299 (delta 3930) remote: Total 7366 (delta 3997), reused 7299 (delta 3930)
Receiving objects: 100% (7366/7366), 2.31 MiB | 95 KiB/s, done. Receiving objects: 100% (7366/7366), 2.31 MiB | 95 KiB/s, done.
Resolving deltas: 100% (3997/3997), done. Resolving deltas: 100% (3997/3997), done.
</literallayout></para> </literallayout>
<para>The same The same
<ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink> <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink>
referenced earlier covers how to referenced earlier covers how to
set up the <filename>meta-intel</filename> Git repository. set up the <filename>meta-intel</filename> Git
</para></listitem> repository.</para></listitem>
</itemizedlist></para></listitem> </itemizedlist></para></listitem>
<listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing
applications using the Eclipse Integrated Development Environment (IDE), applications using the Eclipse Integrated Development Environment (IDE),