summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-07-27 08:07:37 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-08-04 15:06:45 +0100
commit428156844459e931400d63029042ec34826d208d (patch)
tree6ce84374ed520367ff4d6842d59c835fea17a2e9 /documentation
parent24cbfd49267e4a49c97b0da76341a086ac4fda4e (diff)
downloadast2050-yocto-poky-428156844459e931400d63029042ec34826d208d.zip
ast2050-yocto-poky-428156844459e931400d63029042ec34826d208d.tar.gz
documentation/dev-manual/dev-manual-start.xml: Added examples for YP file setup
I moved the section that provides the universal methods of getting a local version of the Yocto Project files and BSP files on the development system into this section. this information needs to be referenced throughout examples so it should be in one location. (From yocto-docs rev: 718ea5b468d816ea4f61a6ffa4de7db396fe3ed4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-start.xml43
1 files changed, 31 insertions, 12 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index a60f256..0954c0f 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -56,25 +56,44 @@
The Packages</ulink> section in the Yocto Project Quick start for the exact package
requirements.</para></listitem>
<listitem><para><emphasis>Yocto Project Release:</emphasis> You need a release of the Yocto Project.
- You can get set up for this one of two ways depending on whether you are going to be contributing
- back into the Yocto Project source repository or not.
+ You can get set up with local Yocto Project files one of two ways depending on whether you
+ are going to be contributing back into the Yocto Project source repository or not.
<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>.
- Once you have the tarball, just extract it into a directory of your choice.
- This method does not produce a <filename>poky</filename> Git repository.
- You end up simply with a snapshot of Yocto Project files that are based on the
- particular release in the tarball.
- If you are interested in supported Board Support Packages (BSPs) you can also download
- these release tarballs from the same site and locate them in a directory of your
- choice.</para></listitem>
+ 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
+ into the current working directory and sets up a file structure whose top-level
+ directory is named <filename>poky-1.1</filename>:
+ <literallayout class='monospaced'>
+ $ tar xfj poky-1.1.tar.bz2
+ </literallayout></para>
+
+ <para>This method does not produce a <filename>poky</filename> Git repository.
+ You end up simply with a local snapshot of Yocto Project files that are based on the
+ particular release in the tarball.</para></listitem>
<listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing
back into the Yocto Project you should probably use Git commands to set up a local
- <filename>poky</filename> Git repository of from the Yocto Project.
+ <filename>poky</filename> Git repository of the Yocto Project.
Doing so creates a Git repository with a complete history of changes and allows
- you to easily submit your changes upstream to the project.
- For an example of how to set up your own local Git repositories see this
+ you to easily submit your changes upstream to the project.</para>
+
+ <para>The following transcript shows how to clone the <filename>poky</filename>
+ Git repository into the current working directory.
+ The command creates the repository in a directory named <filename>poky</filename>:
+ <literallayout class='monospaced'>
+ $ git clone git://git.yoctoproject.org/poky
+ Initialized empty Git repository in /home/scottrif/poky/.git/
+ remote: Counting objects: 107624, done.
+ remote: Compressing objects: 100% (37128/37128), done.
+ remote: Total 107624 (delta 73393), reused 99851 (delta 67287)
+ Receiving objects: 100% (107624/107624), 69.74 MiB | 483 KiB/s, done.
+ Resolving deltas: 100% (73393/73393), 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'>
wiki page</ulink>, which describes how to create both <filename>poky</filename>
and <filename>meta-intel</filename> Git repositories.</para></listitem>
OpenPOWER on IntegriCloud