aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Oberhuber2017-06-11 19:41:01 -0400
committerMartin Oberhuber2017-06-11 19:41:01 -0400
commit7559c7f9305bbafaf8264aebbcbee2b190d914c0 (patch)
tree4a9673d349527469b1e6cdf117f77d00c51498fd
parent55f5a1df52db950c0cfc53b4441e467df6430084 (diff)
downloadorg.eclipse.tcf-7559c7f9305bbafaf8264aebbcbee2b190d914c0.tar.gz
org.eclipse.tcf-7559c7f9305bbafaf8264aebbcbee2b190d914c0.tar.xz
org.eclipse.tcf-7559c7f9305bbafaf8264aebbcbee2b190d914c0.zip
Doc: Update Workspace Creation in Getting Started Docs
Change-Id: I211f19019624a1d619ca2c11a4fb0d181eb8b1e1 Signed-off-by: Martin Oberhuber <mober.at+eclipse@gmail.com>
-rw-r--r--docs/TCF Getting Started.html58
1 files changed, 37 insertions, 21 deletions
diff --git a/docs/TCF Getting Started.html b/docs/TCF Getting Started.html
index 3ac2d14fc..ecdde8884 100644
--- a/docs/TCF Getting Started.html
+++ b/docs/TCF Getting Started.html
@@ -8,12 +8,12 @@
<h1>Target Communication Framework: Getting Started</h1>
-<p>Copyright (c) 2007, 2012 Wind River Systems, Inc. Made available under the EPL v1.0
+<p>Copyright (c) 2007, 2017 Wind River Systems, Inc. and others. Made available under the EPL v1.0
<p>Direct comments, questions to the <a href="https://dev.eclipse.org/mailman/listinfo/tcf-dev">tcf-dev@eclipse.org</a> mailing list
<h2>Table of Contents</h2>
<ul>
- <li><a href='#Workspace'>Creating Eclipse Workspace</a>
+ <li><a href='#Workspace'>Creating an Eclipse Workspace for Development</a>
<li><a href='#Plugins'>TCF Plugins</a>
<li><a href='#TE_Plugins'>Target Explorer Plugins</a>
<li><a href='#Agent'>Building TCF Agent</a>
@@ -25,39 +25,53 @@
<li><a href='#RSE'>Using TCF With Remote System Explorer</a>
</ul>
-<h2><a name='Workspace'>Creating Eclipse Workspace</a></h2>
+<h2><a name='Workspace'>Creating an Eclipse Workspace for Development</a></h2>
<p>Eclipse can be used for developing clients for TCF in Java.
-TCF host side code is organized into several Eclipse plug-in projects,
-below are steps to create and populate Eclipse workspace with TCF projects:</p>
+The TCF host side code is organized into several Eclipse plug-in projects,
+below are steps to create and populate an Eclipse workspace with TCF projects:</p>
<ul>
- <li>Install JDK 1.6.0 or later, recommended 1.7.0
- <li>Install <b>Eclipse SDK 3.8</b> or later, last tested with 4.3.1, recommended 4.3.1<br>
- <a href='http://download.eclipse.org/eclipse/downloads/eclipse3x.php'>http://download.eclipse.org/eclipse/downloads/eclipse3x.php</a>
- <li><b>Optional</b> dependencies for TCF/CDT and TCF/RSE integration: these are not required by
+ <li>Install <b>JDK 1.7.0</b> or later, recommended 1.8.0</li>
+ <li>Install <b>Eclipse SDK 3.8.2</b> or later, last tested with 4.7, recommended 4.7<br>
+ <a href='http://download.eclipse.org/eclipse/downloads/'>http://download.eclipse.org/eclipse/downloads/</a></li>
+ <li>Run Eclipse:
+ <pre>eclipse.exe -vm &lt;JDK path&gt;/bin/javaw.exe -data &lt;Workspace path&gt; -vmargs -Xmx1024M</pre>
+ <li>Open the "Java" perspective.
+ <li>In "Package Explorer" view: do right click and then select "Import...".<ul>
+ <li>If EGit is installed, choose "Git", otherwise choose "General/Existing Projects into Workspace" and click "Next".</li>
+ <li>Clone TCF Java code from <a href='http://git.eclipse.org/c/tcf/org.eclipse.tcf.git'>Eclipse GIT repository</a>.
+ If you intend contributing, best get an account from <a href="">Eclipse Gerrit</a>, sign the CLA, and use the
+ https: URL with your username below. Alternatively, anonymous access is possible as well from any of the below:
+ <pre>
+git clone https://&lt;user&gt;@git.eclipse.org/r/a/tcf/org.eclipse.tcf
+git clone ssh://&lt;user&gt;@git.eclipse.org:29418/tcf/org.eclipse.tcf
+git clone https://git.eclipse.org/r/tcf/org.eclipse.tcf
+git clone git://git.eclipse.org/gitroot/tcf/org.eclipse.tcf
+ </pre></ul></li>
+ <li>Setting the Target Platform:<ul>
+ <li>For import, select root directory: &lt;TCF Root&gt;/admin, and click "Next".
+ <li>From the (admin project)/target-defs/*.target , choose the intended Target Platform and "Open With" &gt; "Target Editor"</li>
+ <li>In the Target Editor, choose "Reload" and "Set as Target Platform". This pulls in all required as well as optional dependencies, along with SWTBot for testing:<ul>
+ <li><b>Optional</b> dependencies for TCF/CDT and TCF/RSE integration: these are not required by
TCF itself or TCF based debugger.
<ul>
- <li><b>CDT (C/C++ Development Tools) SDK 8.1</b> or later, last tested with 8.1.2, recommended 8.1.2<br>
+ <li><b>CDT (C/C++ Development Tools) SDK 8.1</b> or later, last tested with 8.3, recommended 9.3<br>
<a href='http://www.eclipse.org/cdt/downloads.php'>http://www.eclipse.org/cdt/downloads.php</a>
- <li><b>RSE (Remote System Explorer) SDK 3.4</b> or later, last tested with 3.4.1, recommended 3.4.1<br>
+ <li><b>RSE (Remote System Explorer) SDK 3.4</b> or later, last tested with 3.7, recommended 3.7.3<br>
<a href='http://download.eclipse.org/tm/downloads/'>http://download.eclipse.org/tm/downloads/</a>
</ul>
- <li><b>Optional</b> dependencies for Target Explorer:
+ <li><b>Optional</b> dependencies for Target Explorer:
<ul>
+ <li><b>org.eclipse.remote</b> (PTP API for Remote Access) 2.0 or newer<br/>
+ <a href='http://git.eclipse.org/c/ptp/org.eclipse.remote.git'>Git repository at http://git.eclipse.org/c/ptp/org.eclipse.remote.git</a><br/>
+ <a href='https://hudson.eclipse.org/ptp/job/remote-master/'>Hudson Job at https://hudson.eclipse.org/ptp/job/remote-master/</a><br/>
+ Needed for building the TCF provider implementation for org.eclipse.remote, for Trace Compass integration.</li>
<li><b>RXTX (Java library to access serial ports)</b><br>
<a href='http://rxtx.qbang.org/eclipse/'>Eclipse update site at http://rxtx.qbang.org/eclipse/</a><br>
<a href='http://rxtx.qbang.org/eclipse/downloads/'>Download location at http://rxtx.qbang.org/eclipse/downloads/</a>
</ul>
- <li>Clone TCF Java code from <a href='http://git.eclipse.org/c/tcf/org.eclipse.tcf.git'>Eclipse GIT repository</a>, using one of the following commands:
- <pre>
-git clone git://git.eclipse.org/gitroot/tcf/org.eclipse.tcf.git
-git clone ssh://&lt;user&gt;@git.eclipse.org/gitroot/tcf/org.eclipse.tcf.git
-git clone http://git.eclipse.org/gitroot/tcf/org.eclipse.tcf.git
- </pre>
- <li>Run Eclipse:
- <pre>eclipse.exe -vm &lt;JDK path&gt;/bin/javaw.exe -data &lt;Workspace path&gt; -vmargs -Xmx400M</pre>
- <li>Open "Java" perspective.
+ </li></ul></li></ul></li>
<li>In "Package Explorer" view: do right click and then select "Import...".
<li>Select "General/Existing Projects into Workspace" and click "Next".
<li>Select root directory: &lt;TCF Root&gt;/plugins, and click "Next".
@@ -71,6 +85,8 @@ git clone http://git.eclipse.org/gitroot/tcf/org.eclipse.tcf.git
<li>org.eclipse.tcf.rse
</ul>
</ul>
+ <li>Optional: From <b>Window &gt; Preferences &gt; PDE &gt; API Baselines</b>, pick the admin/target-defs/<b>tcf-baseline.target</b>,
+ to get proper warnings and errors about proper API versioning and @since tags.</li>
</ul>
<h2><a name='Plugins'>TCF Plugins</a></h2>