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
Richard Purdie
parent
5de0010aff
commit
184166fa7a
|
|
@ -57,8 +57,8 @@
|
|||
<para>
|
||||
Here is what you need to use the Yocto Project:
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current
|
||||
Linux-based host system.
|
||||
<listitem><para><emphasis>Host System:</emphasis>
|
||||
You should have a reasonably current Linux-based host system.
|
||||
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
|
||||
and officially supported.
|
||||
|
|
@ -69,15 +69,15 @@
|
|||
<para>
|
||||
You should also have about 100 gigabytes of free disk space for building images.
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system
|
||||
requires that certain packages exist on your development system (e.g. Python 2.6 or 2.7).
|
||||
<listitem><para><emphasis>Packages:</emphasis>
|
||||
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>"
|
||||
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>"
|
||||
section in the Yocto Project Reference Manual for the exact
|
||||
package requirements and the installation commands to install
|
||||
them for the supported distributions.
|
||||
</para></listitem>
|
||||
them for the supported distributions.</para></listitem>
|
||||
<listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis>
|
||||
You need a release of the Yocto Project installed locally on
|
||||
your development system.
|
||||
|
|
@ -86,7 +86,8 @@
|
|||
and is created when you use
|
||||
<link linkend='git'>Git</link> to clone a local copy
|
||||
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
|
||||
to contribute back into the Yocto Project or simply work with
|
||||
the latest software on a development branch.
|
||||
|
|
@ -94,7 +95,7 @@
|
|||
a complete history of changes and you are working with a local
|
||||
clone of that repository, you have access to all the Yocto
|
||||
Project development branches and tag names used in the upstream
|
||||
repository.</para>
|
||||
repository.
|
||||
<note>You can view the Yocto Project Source Repositories at
|
||||
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>
|
||||
</note>
|
||||
|
|
@ -108,27 +109,40 @@
|
|||
directory of your choice.</para>
|
||||
<para>For example, the following command extracts the
|
||||
Yocto Project &DISTRO; release tarball
|
||||
into the current working directory and sets up the local Source Directory
|
||||
with a top-level folder named <filename>&YOCTO_POKY;</filename>:
|
||||
into the current working directory and sets up the local
|
||||
Source Directory
|
||||
with a top-level folder named
|
||||
<filename>&YOCTO_POKY;</filename>:
|
||||
<literallayout class='monospaced'>
|
||||
$ tar xfj &YOCTO_POKY_TARBALL;
|
||||
</literallayout></para>
|
||||
<para>This method does not produce a local Git repository.
|
||||
Instead, you simply end up with a snapshot of the release.</para></listitem>
|
||||
<listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing
|
||||
back into the Yocto Project or you simply want to keep up
|
||||
with the latest developments, you should use Git commands to set up a local
|
||||
Git repository of the upstream <filename>poky</filename> source repository.
|
||||
Doing so creates a repository with a complete history of changes and allows
|
||||
you to easily submit your changes upstream to the project.
|
||||
Because you clone the repository, you have access to all the Yocto Project development
|
||||
branches and tag names used in the upstream repository.</para>
|
||||
<note>You can view the Yocto Project Source Repositories at
|
||||
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note>
|
||||
<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
|
||||
<para>This method does not produce a local Git
|
||||
repository.
|
||||
Instead, you simply end up with a snapshot of the
|
||||
release.</para></listitem>
|
||||
<listitem><para><emphasis>Git Repository Method:</emphasis>
|
||||
If you are going to be contributing back into the Yocto
|
||||
Project or you simply want to keep up with the latest
|
||||
developments, you should use Git commands to set up a
|
||||
local Git repository of the upstream
|
||||
<filename>poky</filename> source repository.
|
||||
Doing so creates a repository with a complete history
|
||||
of changes and allows you to easily submit your changes
|
||||
upstream to the project.
|
||||
Because you clone the repository, you have access to all
|
||||
the Yocto Project development branches and tag names
|
||||
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.
|
||||
<literallayout class='monospaced'>
|
||||
$ git clone git://git.yoctoproject.org/poky
|
||||
|
|
@ -138,11 +152,14 @@
|
|||
remote: Total 203728 (delta 147444), reused 202891 (delta 146614)
|
||||
Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done.
|
||||
Resolving deltas: 100% (147444/147444), done.
|
||||
</literallayout></para>
|
||||
<para>For another example of how to set up your own local Git repositories, see this
|
||||
<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>
|
||||
</literallayout>
|
||||
For another example of how to set up your own local
|
||||
Git repositories, see this
|
||||
<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>
|
||||
<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
|
||||
|
|
@ -166,7 +183,7 @@
|
|||
<filename>linux-yocto-3.10.git</filename>, while the
|
||||
copy is named <filename>my-linux-yocto-3.10-work</filename>:
|
||||
<literallayout class='monospaced'>
|
||||
$ git clone --bare git://git.yoctoproject.org/linux-yocto-3.10 linux-yocto-3.10.git
|
||||
$ git clone ‐‐bare git://git.yoctoproject.org/linux-yocto-3.10 linux-yocto-3.10.git
|
||||
Cloning into bare repository 'linux-yocto-3.10.git'...
|
||||
remote: Counting objects: 3364487, done.
|
||||
remote: Compressing objects: 100% (507178/507178), done.
|
||||
|
|
@ -233,20 +250,39 @@
|
|||
See the
|
||||
"<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.</para>
|
||||
<para>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'>
|
||||
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
|
||||
"Downloads" page of the Yocto Project
|
||||
<ulink url='https://www.yoctoproject.org/downloads'>Website</ulink>
|
||||
to get the Yocto Project release.
|
||||
Once on the "Download" page, look to the right of the
|
||||
page and scroll down to find the BSP tarballs.</para>
|
||||
<para>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 of a hierarchical directory
|
||||
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
|
||||
$ git clone git://git.yoctoproject.org/meta-intel.git
|
||||
Cloning into 'meta-intel'...
|
||||
|
|
@ -255,12 +291,12 @@
|
|||
remote: Total 7366 (delta 3997), reused 7299 (delta 3930)
|
||||
Receiving objects: 100% (7366/7366), 2.31 MiB | 95 KiB/s, done.
|
||||
Resolving deltas: 100% (3997/3997), done.
|
||||
</literallayout></para>
|
||||
<para>The same
|
||||
</literallayout>
|
||||
The same
|
||||
<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>
|
||||
set up the <filename>meta-intel</filename> Git
|
||||
repository.</para></listitem>
|
||||
</itemizedlist></para></listitem>
|
||||
<listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing
|
||||
applications using the Eclipse Integrated Development Environment (IDE),
|
||||
|
|
|
|||
Loading…
Reference in New Issue