summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-start.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-07-22 08:40:12 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-08-04 15:06:42 +0100
commitfed0630941ca8cc13dac7ecc68ee3b806786a61c (patch)
treeafb4b17907b9ea57e25ccf8275a6bf78e8d7c553 /documentation/dev-manual/dev-manual-start.xml
parentaf22a8c67196b64f5cb02cf1a320ecc2bbfe3f16 (diff)
downloadpoky-fed0630941ca8cc13dac7ecc68ee3b806786a61c.tar.gz
documentation/dev-manual/dev-manual-start.xml: Edits to clarify YP files
I have a new understanding of the files resulting from setting up Git repos as compared to getting files from tarballs. I changed some wordings to help make those distinctions. (From yocto-docs rev: b7ba9df07cf9d64f61ac73e501c253c42570970d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-start.xml')
-rw-r--r--documentation/dev-manual/dev-manual-start.xml34
1 files changed, 22 insertions, 12 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 5dbe0ed4da..a60f256142 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -62,19 +62,22 @@
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.
66 This method does not produce a <filename>poky</filename> Git repository.
67 You end up simply with a snapshot of Yocto Project files that are based on the
68 particular release in the tarball.
66 If you are interested in supported Board Support Packages (BSPs) you can also download 69 If you are interested in supported Board Support Packages (BSPs) you can also download
67 these release tarballs from the same site and locate them in a directory of your 70 these release tarballs from the same site and locate them in a directory of your
68 choice.</para></listitem> 71 choice.</para></listitem>
69 <listitem><para><emphasis>Git Method:</emphasis> If you are going to be contributing 72 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing
70 back into the Yocto Project you should probably use Git commands to set up a local 73 back into the Yocto Project you should probably use Git commands to set up a local
71 Git repository of the Yocto Project. 74 <filename>poky</filename> Git repository of from the Yocto Project.
72 Doing so creates a history of changes you might make and allows you to easily submit 75 Doing so creates a Git repository with a complete history of changes and allows
73 changes upstream to the project. 76 you to easily submit your changes upstream to the project.
74 For an example of how to set up your own local Git repository of Yocto Project, 77 For an example of how to set up your own local Git repositories see this
75 see this
76 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> 78 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
77 wiki page</ulink>, which covers checking out the Yocto sources.</para></listitem> 79 wiki page</ulink>, which describes how to create both <filename>poky</filename>
80 and <filename>meta-intel</filename> Git repositories.</para></listitem>
78 </itemizedlist></para></listitem> 81 </itemizedlist></para></listitem>
79 <listitem><para><emphasis>Supported Board Support Packages (BSPs):</emphasis> The same considerations 82 <listitem><para><emphasis>Supported Board Support Packages (BSPs):</emphasis> The same considerations
80 exist for BSPs. 83 exist for BSPs.
@@ -83,11 +86,18 @@
83 <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released 86 <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released
84 BSP tarball from the same 87 BSP tarball from the same
85 <ulink url='http://yoctoproject.org/download'>download site</ulink>. 88 <ulink url='http://yoctoproject.org/download'>download site</ulink>.
86 Once you have the tarball just extract it into a directory of your choice.</para></listitem> 89 Once you have the tarball just extract it into a directory of your choice.
87 <listitem><para><emphasis>Git Method:</emphasis> For an example of how to integrate 90 Again, this method just produces a snapshot of the BSP layer in the form
88 the metadata for BSPs into your local Yocto Project Git repository see this 91 of a hierarchical directory structure.</para></listitem>
92 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working
93 with a <filename>poky</filename> Git repository you should also set up a
94 <filename>meta-intel</filename> Git repository.
95 Typically, you set up the <filename>meta-intel</filename> Git repository inside
96 the <filename>poky</filename> Git repository.
97 The same
89 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> 98 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
90 wiki page</ulink>, which covers how to check out the meta-intel repository.</para></listitem> 99 wiki page</ulink> referenced earlier covers how to
100 set up the <filename>meta-intel</filename> Git repository.</para></listitem>
91 </itemizedlist></para></listitem> 101 </itemizedlist></para></listitem>
92 <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing using the 102 <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing using the
93 Eclipse Integrated Development Environment (IDE) you will need this plug-in. 103 Eclipse Integrated Development Environment (IDE) you will need this plug-in.