documentation/adt-manual/adt-eclipse.xml: Added zip method for plug-in install

I added a new subsection to the section that talks about how to install the YP eclipse plug-in. According the Jessica, we should document this method for installing the plug-in. (From yocto-docs rev: dea5b1dacc16c08d61356e95bece2aec581dd16d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
author: Scott Rifenbark <scott.m.rifenbark@intel.com> 2011-09-28 11:43:08 -0700
committer: Richard Purdie <richard.purdie@linuxfoundation.org> 2011-10-04 13:46:40 +0100
commit: 8aa79d7a13595eed729cc71fb2519bc0bc896759 (patch)
tree: e294e0ef4689b6fd12911716c5d70c8729d97899 /documentation/adt-manual
parent: 1bc65c73200f5b1f0b7390eb86451c57e7543d1f (diff)
download: poky-8aa79d7a13595eed729cc71fb2519bc0bc896759.tar.gz
1 files changed, 86 insertions, 28 deletions
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml
index 4fdf90f374..829b2f98f7 100644
--- a/documentation/adt-manual/adt-eclipse.xml
+++ b/documentation/adt-manual/adt-eclipse.xml
@@ -138,40 +138,98 @@
    <title>Installing the Eclipse Yocto Plug-in</title>
        <para>
-            WRITER'S NOTE:  The steps in here are temporary. 
+            You can install the Eclipse Yocto Plug-in one of two methods: use Eclipse IDE commands, 
-            I need to replace them when the real procedure is available from Jessica Zhang.
+            or use the <filename>build.sh</filename> script to build 
+            and then install a zip file of the plug-in.
        </para>
-        <para>
-            To install the Eclipse Yocto Plug-in, follow these steps:
+        <section id='eclipse-ide-method'>
-            <orderedlist>
+        <title>Eclipse IDE Method</title>
-                <listitem><para>Open a shell and create a Git repository with:
-                    <literallayout class='monospaced'>
+            <para>
+                To install the Eclipse Yocto Plug-in by using Eclipse IDE commands,
+                follow these steps:
+                <orderedlist>
+                    <listitem><para>Open a shell and create a Git repository with:
+                        <literallayout class='monospaced'>
     $ git clone git://git.yoctoproject.org/yocto-eclipse yocto-eclipse
-                    </literallayout>
+                        </literallayout>
-                    For this example, I created <filename>~/yocto-eclipse</filename>.</para></listitem>
+                        For this example, I created <filename>~/yocto-eclipse</filename>.</para></listitem>
-                <listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem>
+                    <listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem>
-                <listitem><para>Expand the "General" box and pick "existing projects into workspace".
+                    <listitem><para>Expand the "General" box and pick "existing projects into workspace".
-                    </para></listitem>
+                        </para></listitem>
-                <listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins".
+                    <listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins".
-                    </para></listitem>
+                        </para></listitem>
-                <listitem><para>There will be three things there.
+                    <listitem><para>There will be three things there.
-                    Select each one and install one at a time.
+                        Select each one and install one at a time.
-                    Do all three.</para></listitem>
+                        Do all three.</para></listitem>
-                <listitem><para>Restart everything.</para></listitem>
+                    <listitem><para>Restart everything.</para></listitem>
-            </orderedlist>
+                </orderedlist>
-        </para>
+            </para>
-        <para>
+            <para>
-            At this point I should be able to invoke Eclipse from the shell using the following:
+                At this point you should be able to invoke Eclipse from the shell using the following:
-                    <literallayout class='monospaced'>
+                <literallayout class='monospaced'>
+     $ cd ~/eclipse
+     $ ./eclipse -vmargs -XX:PermSize=256M
+                </literallayout>
+                The left navigation pane shows the default projects. 
+                Right-click on one of these projects and run it as an Eclipse application.
+                This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.
+           </para>
+       </section>
+       <section id='zip-file-method'>
+       <title>Zip File Method</title>
+            <para>
+                To install the Eclipse Yocto Plug-in by building and installing a plug-in 
+                zip file, follow these steps:
+                <orderedlist>
+                    <listitem><para>Open a shell and create a Git repository with:
+                        <literallayout class='monospaced'>
+     $ git clone git://git.yoctoproject.org/yocto-eclipse yocto-eclipse
+                        </literallayout>
+                        For this example, I created <filename>~/yocto-eclipse</filename>.</para></listitem>
+                    <listitem><para>Locate the <filename>build.sh</filename> script in the 
+                        Git repository you created in the previous step.
+                        The script is located in the <filename>scripts</filename>.</para></listitem>
+                    <listitem><para>Be sure to set the <filename>ECLIPSE_HOME</filename> environment
+                        variable to the top-level directory in which you installed the Indigo  
+                        version of Eclipse.
+                        For example, if your Eclipse directory is <filename>$HOME/eclipse</filename>, 
+                        use the following:
+                        <literallayout class='monospaced'>
+     ECLIPSE_HOME=$HOME/eclipse
+                        </literallayout></para></listitem>
+                    <listitem><para>Run the <filename>build.sh</filename> script and provide the 
+                        name of the Git branch along with the Yocto Project release you are 
+                        using.
+                        Here is an example that uses the <filename>master</filename> Git repository
+                        and the <filename>1.1M4</filename> release:
+                        <literallayout class='monospaced'>
+     $ scripts/build.sh master 1.1M4 
+                        </literallayout>
+                        After running the script, the file
+                        <filename>org.yocto.sdk-&lt;release&gt;-&lt;date&gt;-archive.zip</filename>
+                        in the current directory.</para></listitem>
+                    <listitem><para>Install the zip file in the top-level directory of the 
+                        installed Indigo Eclipse IDE.</para></listitem>
+                    <listitem><para>Restart the Eclipse IDE if necessary.</para></listitem>
+                </orderedlist>
+            </para>
+            <para>
+                At this point you should be able to invoke Eclipse from the shell using the following:
+                <literallayout class='monospaced'>
     $ cd ~/eclipse
     $ ./eclipse -vmargs -XX:PermSize=256M
-                    </literallayout>
+                </literallayout>
-            The left navigation pane shows the default projects. 
+                The left navigation pane shows the default projects. 
-            Right-click on one of these projects and run it as an Eclipse application.
+                Right-click on one of these projects and run it as an Eclipse application.
-            This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.
+                This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.
-       </para>            
+           </para>
+       </section>            
    </section>
    <section id='configuring-the-eclipse-yocto-plug-in'>
author	Scott Rifenbark <scott.m.rifenbark@intel.com>	2011-09-28 11:43:08 -0700
committer	Richard Purdie <richard.purdie@linuxfoundation.org>	2011-10-04 13:46:40 +0100
commit	8aa79d7a13595eed729cc71fb2519bc0bc896759 (patch)
tree	e294e0ef4689b6fd12911716c5d70c8729d97899 /documentation/adt-manual
parent	1bc65c73200f5b1f0b7390eb86451c57e7543d1f (diff)
download	poky-8aa79d7a13595eed729cc71fb2519bc0bc896759.tar.gz

diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml index 4fdf90f374..829b2f98f7 100644 --- a/documentation/adt-manual/adt-eclipse.xml +++ b/documentation/adt-manual/adt-eclipse.xml
@@ -138,40 +138,98 @@
138	<title>Installing the Eclipse Yocto Plug-in</title>	138	<title>Installing the Eclipse Yocto Plug-in</title>
139		139
140	<para>	140	<para>
141	WRITER'S NOTE: The steps in here are temporary.	141	You can install the Eclipse Yocto Plug-in one of two methods: use Eclipse IDE commands,
142	I need to replace them when the real procedure is available from Jessica Zhang.	142	or use the <filename>build.sh</filename> script to build
		143	and then install a zip file of the plug-in.
143	</para>	144	</para>
144		145
145	<para>	146
146	To install the Eclipse Yocto Plug-in, follow these steps:	147	<section id='eclipse-ide-method'>
147	<orderedlist>	148	<title>Eclipse IDE Method</title>
148	<listitem><para>Open a shell and create a Git repository with:	149
149	<literallayout class='monospaced'>	150	<para>
		151	To install the Eclipse Yocto Plug-in by using Eclipse IDE commands,
		152	follow these steps:
		153	<orderedlist>
		154	<listitem><para>Open a shell and create a Git repository with:
		155	<literallayout class='monospaced'>
150	$ git clone git://git.yoctoproject.org/yocto-eclipse yocto-eclipse	156	$ git clone git://git.yoctoproject.org/yocto-eclipse yocto-eclipse
151	</literallayout>	157	</literallayout>
152	For this example, I created <filename>~/yocto-eclipse</filename>.</para></listitem>	158	For this example, I created <filename>~/yocto-eclipse</filename>.</para></listitem>
153	<listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem>	159	<listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem>
154	<listitem><para>Expand the "General" box and pick "existing projects into workspace".	160	<listitem><para>Expand the "General" box and pick "existing projects into workspace".
155	</para></listitem>	161	</para></listitem>
156	<listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins".	162	<listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins".
157	</para></listitem>	163	</para></listitem>
158	<listitem><para>There will be three things there.	164	<listitem><para>There will be three things there.
159	Select each one and install one at a time.	165	Select each one and install one at a time.
160	Do all three.</para></listitem>	166	Do all three.</para></listitem>
161	<listitem><para>Restart everything.</para></listitem>	167	<listitem><para>Restart everything.</para></listitem>
162	</orderedlist>	168	</orderedlist>
163	</para>	169	</para>
164		170
165	<para>	171	<para>
166	At this point I should be able to invoke Eclipse from the shell using the following:	172	At this point you should be able to invoke Eclipse from the shell using the following:
167	<literallayout class='monospaced'>	173	<literallayout class='monospaced'>
		174	$ cd ~/eclipse
		175	$ ./eclipse -vmargs -XX:PermSize=256M
		176	</literallayout>
		177	The left navigation pane shows the default projects.
		178	Right-click on one of these projects and run it as an Eclipse application.
		179	This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.
		180	</para>
		181	</section>
		182
		183	<section id='zip-file-method'>
		184	<title>Zip File Method</title>
		185	<para>
		186	To install the Eclipse Yocto Plug-in by building and installing a plug-in
		187	zip file, follow these steps:
		188	<orderedlist>
		189	<listitem><para>Open a shell and create a Git repository with:
		190	<literallayout class='monospaced'>
		191	$ git clone git://git.yoctoproject.org/yocto-eclipse yocto-eclipse
		192	</literallayout>
		193	For this example, I created <filename>~/yocto-eclipse</filename>.</para></listitem>
		194	<listitem><para>Locate the <filename>build.sh</filename> script in the
		195	Git repository you created in the previous step.
		196	The script is located in the <filename>scripts</filename>.</para></listitem>
		197	<listitem><para>Be sure to set the <filename>ECLIPSE_HOME</filename> environment
		198	variable to the top-level directory in which you installed the Indigo
		199	version of Eclipse.
		200	For example, if your Eclipse directory is <filename>$HOME/eclipse</filename>,
		201	use the following:
		202	<literallayout class='monospaced'>
		203	ECLIPSE_HOME=$HOME/eclipse
		204	</literallayout></para></listitem>
		205	<listitem><para>Run the <filename>build.sh</filename> script and provide the
		206	name of the Git branch along with the Yocto Project release you are
		207	using.
		208	Here is an example that uses the <filename>master</filename> Git repository
		209	and the <filename>1.1M4</filename> release:
		210	<literallayout class='monospaced'>
		211	$ scripts/build.sh master 1.1M4
		212	</literallayout>
		213	After running the script, the file
		214	<filename>org.yocto.sdk-<release>-<date>-archive.zip</filename>
		215	in the current directory.</para></listitem>
		216	<listitem><para>Install the zip file in the top-level directory of the
		217	installed Indigo Eclipse IDE.</para></listitem>
		218	<listitem><para>Restart the Eclipse IDE if necessary.</para></listitem>
		219	</orderedlist>
		220	</para>
		221
		222	<para>
		223	At this point you should be able to invoke Eclipse from the shell using the following:
		224	<literallayout class='monospaced'>
168	$ cd ~/eclipse	225	$ cd ~/eclipse
169	$ ./eclipse -vmargs -XX:PermSize=256M	226	$ ./eclipse -vmargs -XX:PermSize=256M
170	</literallayout>	227	</literallayout>
171	The left navigation pane shows the default projects.	228	The left navigation pane shows the default projects.
172	Right-click on one of these projects and run it as an Eclipse application.	229	Right-click on one of these projects and run it as an Eclipse application.
173	This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.	230	This brings up a second instance of Eclipse IDE that has the Yocto Plug-in.
174	</para>	231	</para>
		232	</section>
175	</section>	233	</section>
176		234
177	<section id='configuring-the-eclipse-yocto-plug-in'>	235	<section id='configuring-the-eclipse-yocto-plug-in'>