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)
downloadpoky-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 a60f256142..0954c0ff50 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -56,25 +56,44 @@
56 The Packages</ulink> section in the Yocto Project Quick start for the exact package 56 The Packages</ulink> section in the Yocto Project Quick start for the exact package
57 requirements.</para></listitem> 57 requirements.</para></listitem>
58 <listitem><para><emphasis>Yocto Project Release:</emphasis> You need a release of the Yocto Project. 58 <listitem><para><emphasis>Yocto Project Release:</emphasis> You need a release of the Yocto Project.
59 You can get set up for this one of two ways depending on whether you are going to be contributing 59 You can get set up with local Yocto Project files one of two ways depending on whether you
60 back into the Yocto Project source repository or not. 60 are going to be contributing back into the Yocto Project source repository or not.
61 <itemizedlist> 61 <itemizedlist>
62 <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute 62 <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute
63 back into the Yocto Project you can simply download the Yocto Project release you want 63 back into the Yocto Project you can simply download the Yocto Project release you want
64 from the website’s <ulink url='http://yoctoproject.org/download'>download page</ulink>. 64 from the website’s <ulink url='http://yoctoproject.org/download'>download page</ulink>.
65 Once you have the tarball, just extract it into a directory of your choice. 65 Once you have the tarball, just extract it into a directory of your choice.</para>
66 This method does not produce a <filename>poky</filename> Git repository. 66
67 You end up simply with a snapshot of Yocto Project files that are based on the 67 <para>For example, the following command extracts the Yocto Project 1.1 release tarball
68 particular release in the tarball. 68 into the current working directory and sets up a file structure whose top-level
69 If you are interested in supported Board Support Packages (BSPs) you can also download 69 directory is named <filename>poky-1.1</filename>:
70 these release tarballs from the same site and locate them in a directory of your 70 <literallayout class='monospaced'>
71 choice.</para></listitem> 71 $ tar xfj poky-1.1.tar.bz2
72 </literallayout></para>
73
74 <para>This method does not produce a <filename>poky</filename> Git repository.
75 You end up simply with a local snapshot of Yocto Project files that are based on the
76 particular release in the tarball.</para></listitem>
72 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing 77 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing
73 back into the Yocto Project you should probably use Git commands to set up a local 78 back into the Yocto Project you should probably use Git commands to set up a local
74 <filename>poky</filename> Git repository of from the Yocto Project. 79 <filename>poky</filename> Git repository of the Yocto Project.
75 Doing so creates a Git repository with a complete history of changes and allows 80 Doing so creates a Git repository with a complete history of changes and allows
76 you to easily submit your changes upstream to the project. 81 you to easily submit your changes upstream to the project.</para>
77 For an example of how to set up your own local Git repositories see this 82
83 <para>The following transcript shows how to clone the <filename>poky</filename>
84 Git repository into the current working directory.
85 The command creates the repository in a directory named <filename>poky</filename>:
86 <literallayout class='monospaced'>
87 $ git clone git://git.yoctoproject.org/poky
88 Initialized empty Git repository in /home/scottrif/poky/.git/
89 remote: Counting objects: 107624, done.
90 remote: Compressing objects: 100% (37128/37128), done.
91 remote: Total 107624 (delta 73393), reused 99851 (delta 67287)
92 Receiving objects: 100% (107624/107624), 69.74 MiB | 483 KiB/s, done.
93 Resolving deltas: 100% (73393/73393), done.
94 </literallayout></para>
95
96 <para>For another example of how to set up your own local Git repositories see this
78 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> 97 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
79 wiki page</ulink>, which describes how to create both <filename>poky</filename> 98 wiki page</ulink>, which describes how to create both <filename>poky</filename>
80 and <filename>meta-intel</filename> Git repositories.</para></listitem> 99 and <filename>meta-intel</filename> Git repositories.</para></listitem>