diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-02-02 14:18:55 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-03-08 12:07:49 -0800 |
commit | 9cfbefcc3d25a00054166aeaac49b873a2aa5cd0 (patch) | |
tree | 659a658ccac2918e05f5fe5dd6971a44e01f57f8 /documentation/dev-manual | |
parent | 11c290c3cff74b522c450915df46a9c7b449fda2 (diff) | |
download | poky-9cfbefcc3d25a00054166aeaac49b873a2aa5cd0.tar.gz |
documentation/dev-manual: Edits to clarify YP files
These edits help explain the differences between local YP files
created through a tarball extraction vs cloning a Git repository.
(From yocto-docs rev: ed368800c3e9ece71d27d6d690f0ddc264a4c2da)
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')
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 14 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 8 |
2 files changed, 18 insertions, 4 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 95ef877856..2ff66a4b06 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -205,8 +205,8 @@ | |||
205 | by the maintainer of the source code. | 205 | by the maintainer of the source code. |
206 | For example, in order for a developer to work on a particular piece of code, they need to | 206 | For example, in order for a developer to work on a particular piece of code, they need to |
207 | first get a copy of it from an "upstream" source.</para></listitem> | 207 | first get a copy of it from an "upstream" source.</para></listitem> |
208 | <listitem><para><emphasis>Yocto Project Files:</emphasis> | 208 | <listitem><para id='yocto-project-files'><emphasis>Yocto Project Files:</emphasis> |
209 | This term refers to the directory structure created as a result of downloading | 209 | This term refers to the directory structure created as a result of either downloading |
210 | and unpacking a Yocto Project release tarball or setting up a Git repository | 210 | and unpacking a Yocto Project release tarball or setting up a Git repository |
211 | by cloning <filename>git://git.yoctoproject.org/poky</filename>. | 211 | by cloning <filename>git://git.yoctoproject.org/poky</filename>. |
212 | Sometimes the term "the Yocto Project Files structure" is used as well.</para> | 212 | Sometimes the term "the Yocto Project Files structure" is used as well.</para> |
@@ -220,6 +220,16 @@ | |||
220 | results in a Yocto Project file structure whose Yocto Project source directory is named | 220 | results in a Yocto Project file structure whose Yocto Project source directory is named |
221 | <filename>poky-edison-6.0</filename>. | 221 | <filename>poky-edison-6.0</filename>. |
222 | If you create a Git repository, then you can name the repository anything you like.</para> | 222 | If you create a Git repository, then you can name the repository anything you like.</para> |
223 | <para>It is important to understand the differences between Yocto Project Files created | ||
224 | by unpacking a release tarball as compared to cloning | ||
225 | <filename>git://git.yoctoproject.org/poky</filename>. | ||
226 | When you unpack a tarball, you have an exact copy of the files based on the time of | ||
227 | release - a fixed release point. | ||
228 | Any changes you make to your local Yocto Project files are on top of the release. | ||
229 | On the otherhand, when you clone the Yocto Project Git repository, you have an | ||
230 | active development repository. | ||
231 | In this case, any local changes you make to the Yocto Project can be later applied to active | ||
232 | development branches of the upstream Yocto Project Git repository.</para> | ||
223 | <para>You can find instruction on how to set up the Yocto Project files on your | 233 | <para>You can find instruction on how to set up the Yocto Project files on your |
224 | host development system by reading | 234 | host development system by reading |
225 | the | 235 | the |
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 6d68a088d0..3cb6750d54 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -63,7 +63,9 @@ | |||
63 | for the supported distributions.</para></listitem> | 63 | for the supported distributions.</para></listitem> |
64 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> | 64 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> |
65 | You need a release of the Yocto Project. | 65 | You need a release of the Yocto Project. |
66 | You can get set up with local Yocto Project files one of two ways depending on whether you | 66 | You can get set up with local |
67 | <link linkend='yocto-project-files'>Yocto Project Files</link> one of two ways | ||
68 | depending on whether you | ||
67 | are going to be contributing back into the Yocto Project source repository or not. | 69 | are going to be contributing back into the Yocto Project source repository or not. |
68 | <note> | 70 | <note> |
69 | Regardless of the method you use, this manual refers to the resulting | 71 | Regardless of the method you use, this manual refers to the resulting |
@@ -89,7 +91,9 @@ | |||
89 | back into the Yocto Project, you should use Git commands to set up a local | 91 | back into the Yocto Project, you should use Git commands to set up a local |
90 | Git repository of the Yocto Project files. | 92 | Git repository of the Yocto Project files. |
91 | Doing so creates a Git repository with a complete history of changes and allows | 93 | Doing so creates a Git repository with a complete history of changes and allows |
92 | you to easily submit your changes upstream to the project.</para> | 94 | you to easily submit your changes upstream to the project. |
95 | Because you cloned the repository, you have access to all the Yocto Project development | ||
96 | branches and tag names used in the upstream repository.</para> | ||
93 | <para>The following transcript shows how to clone the Yocto Project files' | 97 | <para>The following transcript shows how to clone the Yocto Project files' |
94 | Git repository into the current working directory. | 98 | Git repository into the current working directory. |
95 | The command creates the repository in a directory named <filename>poky</filename>. | 99 | The command creates the repository in a directory named <filename>poky</filename>. |