mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-03 14:25:37 +02:00
Code Issues Wiki Activity

Fix 158529: Migrate remotecdt docs to HTML / TOC format

Browse source
This commit is contained in:
Martin Oberhuber 2006-11-10 21:08:48 +00:00
parent 068da42bae
commit 4f8e836a47
7 changed files with 125 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
rse/doc/org.eclipse.rse.doc.user/plugin.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2006 IBM Corporation and others. All rights reserved.
This program and the accompanying materials are made available under the terms
of the Eclipse Public License v1.0 which accompanies this distribution, and is
available at http://www.eclipse.org/legal/epl-v10.html
Initial Contributors:
The following IBM employees contributed to the Remote System Explorer
component that contains this file: David McKnight, Kushal Munir,
Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
Contributors:
{Name} (company) - description of contribution.
-->
<plugin>
<extension point="org.eclipse.help.toc">
<toc file="toc.xml" primary="true" />
</extension>
</plugin>
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2006 IBM Corporation and others. All rights reserved.
This program and the accompanying materials are made available under the terms
of the Eclipse Public License v1.0 which accompanies this distribution, and is
available at http://www.eclipse.org/legal/epl-v10.html
Initial Contributors:
The following IBM employees contributed to the Remote System Explorer
component that contains this file: David McKnight, Kushal Munir,
Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
Contributors:
{Name} (company) - description of contribution.
-->
<plugin>
<extension point="org.eclipse.help.toc">
<toc file="toc.xml" primary="true" category="DSDP.TM"/>
</extension>
</plugin>

1
rse/doc/org.eclipse.rse.doc.user/toc.xml
View file

@ -57,5 +57,6 @@
-->
<topic label="Accessing Remote System Explorer preferences" href="ref/rrsepref.html"/>
<topic label="Saving User IDs and passwords" href="tasks/tbeginpass.html"/>
<anchor id="rse_user_extensions" />
<topic label="Legal" href="notices.html"/>
</toc>

4
rse/examples/org.eclipse.rse.remotecdt/build.properties
View file

@ -7,6 +7,7 @@
#
# Contributors:
# Ewa Matejska (PalmSource)
# Martin Oberhuber (Wind River) - fix 158529: Migrate docs to HTML / TOC format
#####################################################################################
source.. = src/
@ -19,10 +20,11 @@ bin.includes = META-INF/,\
eclipse32.png,\
plugin.properties,\
plugin.xml,\
remotecdt.html,\
toc.xml,\
icons/,\
.
src.includes = META-INF/,\
about.html,\
icons/,\
instructions.txt,\
plugin.xml

57
rse/examples/org.eclipse.rse.remotecdt/instructions.txt
View file

@ -1,57 +0,0 @@
Introduction
--------------
The attached plugin (org.eclipse.rse.remotecdt) builds on top of CDT and integrates with RSE to introduce
a "Remote C/C++ Application" launch configuration. This launch configuration relies on the shell and file
services of the RSE connections.
The "Remote C/C++ Application" launch configuration enables the user to select from a list of RSE
connections which have the shell service available. For a debug launch, the binary is downloaded
to the remote using the file service of the RSE connection, gdbserver is automatically started
on the remote using the shell service and a gdb debug connection is establised. For a run launch,
the binary is downloaded to the remote using the file service and then it is invoked using the shell
service.
In the future, an RSE file service should be used in the future to select where the remote download
should take place. Right now the remote path is entered manually in a text field.
System Prerequisites
------------------
Local Host
A. It is necessary to create an RSE connection which has the file and shell services
available.
Remote Host
A. gdbserver is on the path.
B. port 2345 is available to use. gdbserver will use this port.
Installation of Necessary Eclipse Components
---------------------------------
1. Install Eclipse 3.2.
2. Install CDT 3.1.
3. Install RSE. This is the procedure I followed.
A. Checkout RSE from the repository using anonymous username.
B. Import the plugin directory and build all the RSE plugins.
4. Import the Remote CDT plugin and build that.
Using
----------
A "Remote C++ Application" launch configuration will be available.
After building a binary which will run on your remote, try using this
configuration to run or debug it.
Current Limitations
-----------
There is no way to tell when the command on the remote has finished
running. As a result, the "Remote Shell" process will be left active
after the debug session dies and needs to be terminated manually. The
run process also needs to be terminated manually for the same reason.

14
rse/examples/org.eclipse.rse.remotecdt/plugin.xml
View file

@ -1,4 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2006 PalmSource, Inc. and others
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Ewa Matejska (PalmSource) - initial API and implementation
Martin Oberhuber (Wind River) - fix 158529: Migrate docs to HTML / TOC format
-->
<?eclipse version="3.0"?>
<plugin>
<extension
@ -29,5 +40,8 @@
id="org.eclipse.rse.remotecdt.RemoteLaunchTabGroup">
</launchConfigurationTabGroup>
</extension>
<extension point="org.eclipse.help.toc">
<toc file="toc.xml"/>
</extension>
</plugin>

69
rse/examples/org.eclipse.rse.remotecdt/remotecdt.html Normal file
View file

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
Copyright (c) 2006 PalmSource, Inc. and others
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Ewa Matejska (PalmSource) - initial API and implementation
Martin Oberhuber (Wind River) - fix 158529: Migrate docs to HTML / TOC format
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="copyright" content="Copyright (c) 2006 PalmSource, Inc. and others. This page is made available under license. For full details see the LEGAL notice in the documentation book that contains this page." >
<link rel="stylesheet" type="text/css" href="../org.eclipse.rse.doc.user/book.css" />
<title>Launching Remote C/C++ Applications</title>
</head>
<body id="tremotecdt"><a name="tremotecdt"><!-- --></a>
<h1 class="topictitle1">Launching Remote C/C++ Applications</h1>
<div class="p">
<p>The RSE Remote CDT Plugin builds on top of CDT and integrates with RSE to introduce
a "Remote C/C++ Application" launch configuration. This launch configuration relies
on the shell and file services of the RSE connections.</p>
<p>The "Remote C/C++ Application" launch configuration enables the user to select from a list of RSE
connections which have the shell service available. For a debug launch, the binary is downloaded
to the remote using the file service of the RSE connection, gdbserver is automatically started
on the remote using the shell service and a gdb debug connection is establised. For a run launch,
the binary is downloaded to the remote using the file service and then it is invoked using the shell
service.</p>
<p>In the future, an RSE file service should be used to select where the remote download
should take place. Right now the remote path is entered manually in a text field.</p>
</div>
<h2>System Prerequisites</h2>
<div class="p"><b>Local Host</b>
<ul>
<li>It is necessary to create an RSE connection which has the file and shell services
available.</li>
</ul></div>
<div class="p"><b>Remote Host</b>
<ul>
<li>gdbserver is on the path.</li>
<li>port 2345 is available to use. gdbserver will use this port.</li>
</ul></div>
<h2>Using</h2>
<div class="p">
<p>A "Remote C++ Application" launch configuration will be available.
After building a binary which will run on your remote, try using this
configuration to run or debug it.</p>
</div>
<h2>Current Limitations</h2>
<div class="p">
<p>There is no way to tell when the command on the remote has finished
running. As a result, the "Remote Shell" process will be left active
after the debug session dies and needs to be terminated manually. The
run process also needs to be terminated manually for the same reason.</p>
</div>
</body>
</html>

16
rse/examples/org.eclipse.rse.remotecdt/toc.xml Normal file
View file

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<!--
Copyright (c) 2006 Wind River Systems, Inc.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<toc link_to="../org.eclipse.rse.doc.user/toc.xml#rse_user_extensions"
label="Launching Remote C/C++ Applications">
<topic label="Launching Remote C/C++ Applications" href="remotecdt.html"/>
</toc>