summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-01-19 17:35:13 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-01-30 16:06:00 +0000
commit1bafc894317c64cc64c2209baeca2ddf8409be7b (patch)
treee08830126bb5e8f2dd724d4c8f70f341c0f346ca /documentation
parentdc785b64c1a619b139396377a3a2c61d770f759c (diff)
downloadpoky-1bafc894317c64cc64c2209baeca2ddf8409be7b.tar.gz
documentation/adt-manual/adt-eclipse.xml: Updates to plug-in install
I worked through these methods and discovered a bit more on how they actually work and when the user would use a given method. The updates reflect this new knowledge. (From yocto-docs rev: 346652df7a3423b82a10d41aa2d7dcddb803ad6f) 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/adt-manual/adt-eclipse.xml111
1 files changed, 58 insertions, 53 deletions
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml
index 50275091b5..4fff20c25e 100644
--- a/documentation/adt-manual/adt-eclipse.xml
+++ b/documentation/adt-manual/adt-eclipse.xml
@@ -53,10 +53,12 @@
53 <para> 53 <para>
54 Once you have downloaded the tarball, extract it into a clean 54 Once you have downloaded the tarball, extract it into a clean
55 directory. 55 directory.
56 For example, the following command unpacks and installs the Eclipse IDE 56 For example, the following commands unpack and install the Eclipse IDE
57 tarball found in the <filename>Downloads</filename> area
57 into a clean directory using the default name <filename>eclipse</filename>: 58 into a clean directory using the default name <filename>eclipse</filename>:
58 <literallayout class='monospaced'> 59 <literallayout class='monospaced'>
59 $ tar -xzvf ~/Downloads/Eclipse-SDK-3.7-linux-gtk-x86_64.tar.gz 60 $ cd ~
61 $ tar -xzvf ~/Downloads/eclipse-SDK-3.7.1-linux-gtk-x86_64.tar.gz
60 </literallayout> 62 </literallayout>
61 </para> 63 </para>
62 64
@@ -138,30 +140,36 @@
138 </section> 140 </section>
139 141
140 <section id='installing-the-eclipse-yocto-plug-in'> 142 <section id='installing-the-eclipse-yocto-plug-in'>
141 <title>Installing the Eclipse Yocto Plug-in</title> 143 <title>Installing or Accessing the Eclipse Yocto Plug-in</title>
142 144
143 <para> 145 <para>
144 You can install the Eclipse Yocto Plug-in one of three methods: as new software 146 You can install the Eclipse Yocto Plug-in into the Eclipse application
145 from within the Eclipse IDE, from the Yocto Project source repositories, or as a built zip file. 147 one of two ways: using the Eclipse IDE and installing the plug-in as new software, or
148 using a built zip file.
149 If you don't want to permanently install the plug-in but just want to try it out
150 within the Eclipse environment, you can import the plug-in project from the
151 Yocto Project source repositories.
146 </para> 152 </para>
147 153
148 <section id='new-software'> 154 <section id='new-software'>
149 <title>New Software</title> 155 <title>Installing the Plug-in as New Software</title>
150 156
151 <para> 157 <para>
152 To install the Eclipse Yocto Plug-in directly into the Eclipse IDE, 158 To install the Eclipse Yocto Plug-in as new software directly into the Eclipse IDE,
153 follow these steps: 159 follow these steps:
154 <orderedlist> 160 <orderedlist>
155 <listitem><para>Start up the Eclipse IDE.</para></listitem> 161 <listitem><para>Start up the Eclipse IDE.</para></listitem>
156 <listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem> 162 <listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem>
157 <listitem><para>Click "Add..." in the "Work with:" area.</para></listitem> 163 <listitem><para>Click "Add..." in the "Work with:" area.</para></listitem>
158 <listitem><para>Enter 164 <listitem><para>Enter
159 <filename>http://www.yoctoproject.org/downloads/eclipse-plugin/1.1.1</filename> 165 <filename>http://downloads.yoctoproject.org/releases/eclipse-plugin/1.1.1</filename>
160 in the URL field and provide a meaningful name in the "Name" field.</para></listitem> 166 in the URL field and provide a meaningful name in the "Name" field.</para></listitem>
161 <listitem><para>Click "OK" to have the entry added to the "Work with:" 167 <listitem><para>Click "OK" to have the entry added to the "Work with:"
162 drop-down list.</para></listitem> 168 drop-down list.</para></listitem>
163 <listitem><para>Select the entry for the plug-in from the "Work with:" drop-down 169 <listitem><para>Select the entry for the plug-in from the "Work with:" drop-down
164 list.</para></listitem> 170 list.</para></listitem>
171 <listitem><para>Check the box next to <filename>Development tools and SDKs for Yocto Linux</filename>.
172 </para></listitem>
165 <listitem><para>Complete the remaining software installation steps and 173 <listitem><para>Complete the remaining software installation steps and
166 then restart the Eclipse IDE to finish the installation of the plug-in. 174 then restart the Eclipse IDE to finish the installation of the plug-in.
167 </para></listitem> 175 </para></listitem>
@@ -169,46 +177,8 @@
169 </para> 177 </para>
170 </section> 178 </section>
171 179
172
173 <section id='yocto-project-source'>
174 <title>Yocto Project Source</title>
175
176 <para>
177 To install the Eclipse Yocto Plug-in from the Yocto Project source repositories,
178 follow these steps:
179 <orderedlist>
180 <listitem><para>Open a shell and create a Git repository with:
181 <literallayout class='monospaced'>
182 $ git clone git://git.yoctoproject.org/eclipse-poky yocto-eclipse
183 </literallayout>
184 For this example, the repository is named
185 <filename>~/yocto-eclipse</filename>.</para></listitem>
186 <listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem>
187 <listitem><para>Expand the "General" box and pick "existing projects into workspace".
188 </para></listitem>
189 <listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins".
190 </para></listitem>
191 <listitem><para>There will be three things there.
192 Select each one and install one at a time.
193 Do all three.</para></listitem>
194 <listitem><para>Restart everything.</para></listitem>
195 </orderedlist>
196 </para>
197
198 <para>
199 At this point you should be able to invoke Eclipse from the shell using the following:
200 <literallayout class='monospaced'>
201 $ cd ~/eclipse
202 $ ./eclipse -vmargs -XX:PermSize=256M
203 </literallayout>
204 The left navigation pane shows the default projects.
205 Right-click on one of these projects and run it as an Eclipse application.
206 This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.
207 </para>
208 </section>
209
210 <section id='zip-file-method'> 180 <section id='zip-file-method'>
211 <title>Zip File Method</title> 181 <title>Installing the Plug-in from a Zip File</title>
212 <para> 182 <para>
213 To install the Eclipse Yocto Plug-in by building and installing a plug-in 183 To install the Eclipse Yocto Plug-in by building and installing a plug-in
214 zip file, follow these steps: 184 zip file, follow these steps:
@@ -247,22 +217,57 @@
247 </para></listitem> 217 </para></listitem>
248 <listitem><para>Click "Add".</para></listitem> 218 <listitem><para>Click "Add".</para></listitem>
249 <listitem><para>Provide anything you want in the "Name" field.</para></listitem> 219 <listitem><para>Provide anything you want in the "Name" field.</para></listitem>
250 <listitem><para>For the "Archive" field, select the ZIP file you built in step 220 <listitem><para>Click "Archive" and browse to the ZIP file you built
251 4. 221 in step four.
252 This ZIP file should not be "unzipped", and must be the 222 This ZIP file should not be "unzipped", and must be the
253 <filename>*archive.zip</filename> file created by running the 223 <filename>*archive.zip</filename> file created by running the
254 <filename>build.sh</filename> script.</para></listitem> 224 <filename>build.sh</filename> script.</para></listitem>
255 <listitem><para>Select the new entry in the installation window and complete 225 <listitem><para>Check the box next to the new entry in the installation window and complete
256 the installation.</para></listitem> 226 the installation.</para></listitem>
257 <listitem><para>Restart the Eclipse IDE if necessary.</para></listitem> 227 <listitem><para>Restart the Eclipse IDE if necessary.</para></listitem>
258 </orderedlist> 228 </orderedlist>
259 </para> 229 </para>
260 230
261 <para> 231 <para>
262 At this point you should be able to configure the Eclipse Yocto Plug-in as described in 232 At this point you should be able to configure the Eclipse Yocto Plug-in as described in the
263 the next section. 233 "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>"
234 section.</para>
235 </section>
236
237 <section id='yocto-project-source'>
238 <title>Importing the Plug-in Project into the Eclipse Environment</title>
239 <para>
240 Importing the Eclipse Yocto Plug-in project from the Yocto Project source repositories
241 is useful when you want to try out the latest plug-in from the tip of plug-in's
242 development tree.
243 It is important to understand when you import the plug-in you are not installing
244 it into the Eclipse application.
245 Rather, you are importing the project and just using it.
246 To import the plug-in project, follow these steps:
247 <orderedlist>
248 <listitem><para>Open a shell and create a Git repository with:
249 <literallayout class='monospaced'>
250 $ git clone git://git.yoctoproject.org/eclipse-poky yocto-eclipse
251 </literallayout>
252 For this example, the repository is named
253 <filename>~/yocto-eclipse</filename>.</para></listitem>
254 <listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem>
255 <listitem><para>Expand the "General" box and select "existing projects into workspace"
256 and then click "Next".</para></listitem>
257 <listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins".
258 </para></listitem>
259 <listitem><para>There will be three things there.
260 Select each one and install one at a time.
261 Do all three.</para></listitem>
262 </orderedlist>
263 </para>
264
265 <para>
266 The left navigation pane in the Eclipse application shows the default projects.
267 Right-click on one of these projects and run it as an Eclipse application.
268 This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.
264 </para> 269 </para>
265 </section> 270 </section>
266 </section> 271 </section>
267 272
268 <section id='configuring-the-eclipse-yocto-plug-in'> 273 <section id='configuring-the-eclipse-yocto-plug-in'>