diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-10-29 07:37:31 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-11-01 17:09:55 +0000 |
commit | 4d69fc1ad65e8ff049cfeb69437ca7c2896f5de9 (patch) | |
tree | dd3eb4d66127d88473f9c72dabd0c9d2f1300b52 /documentation | |
parent | 57d2417eacf45206328c5791524597691f2f1ff0 (diff) | |
download | poky-4d69fc1ad65e8ff049cfeb69437ca7c2896f5de9.tar.gz |
dev-manual: Removed tarball method for poky in setup section
Fixes [YOCTO #5368]
Partial fix for the bug. This part removed the tarball install
method from the getting setup section of the second chapter. I
did some rewriting to smooth it out.
(From yocto-docs rev: b051433e34e0f3a46deba0b2b4815ab77fde62c8)
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.xml | 78 |
1 files changed, 32 insertions, 46 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 0729baa0da..b0f5e120bd 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -79,47 +79,32 @@ | |||
79 | them for the supported distributions. | 79 | them for the supported distributions. |
80 | </para></listitem> | 80 | </para></listitem> |
81 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> | 81 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> |
82 | You need a release of the Yocto Project. | 82 | You need a release of the Yocto Project installed locally on |
83 | You set that up with a local <link linkend='source-directory'>Source Directory</link> | 83 | your development system. |
84 | one of two ways depending on whether you | 84 | This local area is referred to as the |
85 | are going to contribute back into the Yocto Project or not. | 85 | <link linkend='source-directory'>Source Directory</link> |
86 | <note> | 86 | and is created when you use |
87 | Regardless of the method you use, this manual refers to the resulting local | 87 | <link linkend='git'>Git</link> to clone a local copy |
88 | hierarchical set of files as the "Source Directory." | 88 | of the upstream <filename>poky</filename> repository.</para> |
89 | <para>Working from a copy of the upstream repository allows you | ||
90 | to contribute back into the Yocto Project or simply work with | ||
91 | the latest software on a development branch. | ||
92 | Because Git maintains and creates an upstream repository with | ||
93 | a complete history of changes and you are working with a local | ||
94 | clone of that repository, you have access to all the Yocto | ||
95 | Project development branches and tag names used in the upstream | ||
96 | repository.</para> | ||
97 | <note>You can view the Yocto Project Source Repositories at | ||
98 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> | ||
89 | </note> | 99 | </note> |
90 | <itemizedlist> | 100 | <para>The following transcript shows how to clone the |
91 | <listitem><para><emphasis>Tarball Extraction:</emphasis> | 101 | <filename>poky</filename> Git repository into the current |
92 | If you are not going to contribute back into the Yocto | 102 | working directory. |
93 | Project, you can simply go to the | 103 | The command creates the local repository in a directory |
94 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>, | 104 | named <filename>poky</filename>. |
95 | select the "Downloads" tab, and choose what you want. | 105 | For information on Git used within the Yocto Project, see |
96 | Once you have the tarball, just extract it into a | 106 | the "<link linkend='git'>Git</link>" section. |
97 | directory of your choice.</para> | 107 | <literallayout class='monospaced'> |
98 | <para>For example, the following command extracts the | ||
99 | Yocto Project &DISTRO; release tarball | ||
100 | into the current working directory and sets up the local Source Directory | ||
101 | with a top-level folder named <filename>&YOCTO_POKY;</filename>: | ||
102 | <literallayout class='monospaced'> | ||
103 | $ tar xfj &YOCTO_POKY_TARBALL; | ||
104 | </literallayout></para> | ||
105 | <para>This method does not produce a local Git repository. | ||
106 | Instead, you simply end up with a snapshot of the release.</para></listitem> | ||
107 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing | ||
108 | back into the Yocto Project or you simply want to keep up | ||
109 | with the latest developments, you should use Git commands to set up a local | ||
110 | Git repository of the upstream <filename>poky</filename> source repository. | ||
111 | Doing so creates a repository with a complete history of changes and allows | ||
112 | you to easily submit your changes upstream to the project. | ||
113 | Because you clone the repository, you have access to all the Yocto Project development | ||
114 | branches and tag names used in the upstream repository.</para> | ||
115 | <note>You can view the Yocto Project Source Repositories at | ||
116 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> | ||
117 | <para>The following transcript shows how to clone the <filename>poky</filename> | ||
118 | Git repository into the current working directory. | ||
119 | The command creates the local repository in a directory named <filename>poky</filename>. | ||
120 | For information on Git used within the Yocto Project, see the | ||
121 | "<link linkend='git'>Git</link>" section. | ||
122 | <literallayout class='monospaced'> | ||
123 | $ git clone git://git.yoctoproject.org/poky | 108 | $ git clone git://git.yoctoproject.org/poky |
124 | Cloning into 'poky'... | 109 | Cloning into 'poky'... |
125 | remote: Counting objects: 203728, done. | 110 | remote: Counting objects: 203728, done. |
@@ -127,12 +112,13 @@ | |||
127 | remote: Total 203728 (delta 147444), reused 202891 (delta 146614) | 112 | remote: Total 203728 (delta 147444), reused 202891 (delta 146614) |
128 | Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done. | 113 | Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done. |
129 | Resolving deltas: 100% (147444/147444), done. | 114 | Resolving deltas: 100% (147444/147444), done. |
130 | </literallayout></para> | 115 | </literallayout></para> |
131 | <para>For another example of how to set up your own local Git repositories, see this | 116 | <para>For another example of how to set up your own local Git |
132 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> | 117 | repositories, see this |
133 | wiki page</ulink>, which describes how to create both <filename>poky</filename> | 118 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> |
134 | and <filename>meta-intel</filename> Git repositories.</para></listitem> | 119 | wiki page</ulink>, which describes how to create both |
135 | </itemizedlist></para></listitem> | 120 | <filename>poky</filename> and <filename>meta-intel</filename> |
121 | Git repositories.</para></listitem> | ||
136 | <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> | 122 | <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> |
137 | If you are going to be making modifications to a supported Yocto Project kernel, you | 123 | If you are going to be making modifications to a supported Yocto Project kernel, you |
138 | need to establish local copies of the source. | 124 | need to establish local copies of the source. |