diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-02-02 11:16:54 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-03-08 12:07:49 -0800 |
commit | 11c290c3cff74b522c450915df46a9c7b449fda2 (patch) | |
tree | 7a0d71ee92aff7040ab26d786048e8b70db6743a /documentation | |
parent | e71d0af563ba22f5be6c9740de418f4113334657 (diff) | |
download | poky-11c290c3cff74b522c450915df46a9c7b449fda2.tar.gz |
documentation/dev-manual/dev-manual-bsp-appendix.xml: tags/branches edits
Edits to the section describing how to set up the YP files before the
BSP example. I am working with Joshua Lock on these to settle them
down. The edits are trying to establish understanding between a
Git repository and a tarball... just what the user has a hold of
after getting the files by either method.
Reported-by: Joshua Lock <joshua.lock@intel.com>
(From yocto-docs rev: ddb8333ea2f9898b7016ca01887e1acdc0581c06)
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-bsp-appendix.xml | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml index 51fb3f4f4f..8a5ad73f86 100644 --- a/documentation/dev-manual/dev-manual-bsp-appendix.xml +++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml | |||
@@ -31,7 +31,7 @@ | |||
31 | The following paragraphs describe both methods. | 31 | The following paragraphs describe both methods. |
32 | For additional information, see the bulleted item | 32 | For additional information, see the bulleted item |
33 | "<link linkend='local-yp-release'>Yocto Project Release</link>". | 33 | "<link linkend='local-yp-release'>Yocto Project Release</link>". |
34 | </para> | 34 | </para> |
35 | 35 | ||
36 | <para> | 36 | <para> |
37 | As mentioned, one way to get the Yocto Project files is to use Git to clone the | 37 | As mentioned, one way to get the Yocto Project files is to use Git to clone the |
@@ -45,19 +45,26 @@ | |||
45 | $ tar xfj poky-edison-6.0.tar.bz2 | 45 | $ tar xfj poky-edison-6.0.tar.bz2 |
46 | $ cd poky | 46 | $ cd poky |
47 | </literallayout> | 47 | </literallayout> |
48 | <note>If you're using the tarball method, you can ignore all the following steps that | 48 | <note><para>If you're using the tarball method, you can ignore all the following steps that |
49 | ask you to carry out Git operations. | 49 | ask you to carry out Git operations. |
50 | You already have the results of those operations | 50 | You already have the results of those operations |
51 | in the form of the edison release tarballs. | 51 | in the form of the edison release tarballs. |
52 | Consequently, there is nothing left to do other than extract those tarballs into the | 52 | Consequently, there is nothing left to do other than extract those tarballs into the |
53 | proper locations.</note> | 53 | proper locations.</para> |
54 | |||
55 | <para>Once you expand the released tarball, you have a snapshot of the Git repository | ||
56 | that represents a specific release. | ||
57 | Fundamentally, this is different than having a local copy of the Yocto Project | ||
58 | Git repository. | ||
59 | Given the tarball method, changes you make are building on top of a release, while | ||
60 | you are tracking development when you use the Git repository method.</para></note> | ||
54 | </para> | 61 | </para> |
55 | 62 | ||
56 | <para> | 63 | <para> |
57 | Once you have the local <filename>poky</filename> Git repository set up, | 64 | With the local <filename>poky</filename> Git repository set up, |
58 | you have all the development branches available to you from which you can work. | 65 | you have all the development branches available to you from which you can work. |
59 | However, you need to be sure that your local repository reflects the specific | 66 | Next, you need to be sure that your local repository reflects the exact |
60 | snapshot of the release you are interested in. | 67 | release in which you are interested. |
61 | From inside the repository you can see the development branches that represent | 68 | From inside the repository you can see the development branches that represent |
62 | areas of development that have diverged from the main (master) branch. | 69 | areas of development that have diverged from the main (master) branch. |
63 | You can also see the tag names used to mark snapshots of stable releases or | 70 | You can also see the tag names used to mark snapshots of stable releases or |
@@ -70,8 +77,8 @@ | |||
70 | </literallayout> | 77 | </literallayout> |
71 | For this example, we are going to use the Yocto Project 1.1 Release, which is code | 78 | For this example, we are going to use the Yocto Project 1.1 Release, which is code |
72 | named "edison". | 79 | named "edison". |
73 | To make sure we have a local area (branch in Git terms) on our machine that tracks | 80 | To make sure we have a local area (branch in Git terms) on our machine that |
74 | the snapshot of the 1.1 release, we can use the following commands: | 81 | reflects the 1.1 release, we can use the following commands: |
75 | <literallayout class='monospaced'> | 82 | <literallayout class='monospaced'> |
76 | $ cd ~/poky | 83 | $ cd ~/poky |
77 | $ git fetch --tags | 84 | $ git fetch --tags |
@@ -84,10 +91,10 @@ | |||
84 | local repository. | 91 | local repository. |
85 | The Git <filename>checkout</filename> command with the <filename>-b</filename> option | 92 | The Git <filename>checkout</filename> command with the <filename>-b</filename> option |
86 | creates a local branch for you named <filename>edison</filename>. | 93 | creates a local branch for you named <filename>edison</filename>. |
87 | Your local branch tracks the Yocto Project 1.1 released tarball marked with the | 94 | Your local branch begins in the same state as the Yocto Project 1.1 released tarball |
88 | <filename>edison-6.0</filename> tag in the source repositories. | 95 | marked with the <filename>edison-6.0</filename> tag in the source repositories. |
89 | </para> | 96 | </para> |
90 | </section> | 97 | </section> |
91 | 98 | ||
92 | <section id='choosing-a-base-bsp-app'> | 99 | <section id='choosing-a-base-bsp-app'> |
93 | <title>Choosing a Base BSP</title> | 100 | <title>Choosing a Base BSP</title> |