diff --git a/rse/doc/org.eclipse.rse.doc.user/plugin.xml b/rse/doc/org.eclipse.rse.doc.user/plugin.xml index 00f2e242fff..f7998658999 100755 --- a/rse/doc/org.eclipse.rse.doc.user/plugin.xml +++ b/rse/doc/org.eclipse.rse.doc.user/plugin.xml @@ -1,22 +1,22 @@ - - - - - - - - + + + + + + + + diff --git a/rse/doc/org.eclipse.rse.doc.user/toc.xml b/rse/doc/org.eclipse.rse.doc.user/toc.xml index 6fe447d1bf8..735806670dc 100755 --- a/rse/doc/org.eclipse.rse.doc.user/toc.xml +++ b/rse/doc/org.eclipse.rse.doc.user/toc.xml @@ -57,5 +57,6 @@ --> + \ No newline at end of file diff --git a/rse/examples/org.eclipse.rse.remotecdt/build.properties b/rse/examples/org.eclipse.rse.remotecdt/build.properties index 5a542ded930..290d5997270 100644 --- a/rse/examples/org.eclipse.rse.remotecdt/build.properties +++ b/rse/examples/org.eclipse.rse.remotecdt/build.properties @@ -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 diff --git a/rse/examples/org.eclipse.rse.remotecdt/instructions.txt b/rse/examples/org.eclipse.rse.remotecdt/instructions.txt deleted file mode 100644 index e1136a91d8d..00000000000 --- a/rse/examples/org.eclipse.rse.remotecdt/instructions.txt +++ /dev/null @@ -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. - - diff --git a/rse/examples/org.eclipse.rse.remotecdt/plugin.xml b/rse/examples/org.eclipse.rse.remotecdt/plugin.xml index 661730900ac..717f423aec6 100644 --- a/rse/examples/org.eclipse.rse.remotecdt/plugin.xml +++ b/rse/examples/org.eclipse.rse.remotecdt/plugin.xml @@ -1,4 +1,15 @@ + + + + diff --git a/rse/examples/org.eclipse.rse.remotecdt/remotecdt.html b/rse/examples/org.eclipse.rse.remotecdt/remotecdt.html new file mode 100644 index 00000000000..df01b7bfa83 --- /dev/null +++ b/rse/examples/org.eclipse.rse.remotecdt/remotecdt.html @@ -0,0 +1,69 @@ + + + + + + + + +Launching Remote C/C++ Applications + + + +

Launching Remote C/C++ Applications

+
+

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.

+ +

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 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 +
    +
  • It is necessary to create an RSE connection which has the file and shell services + available.
  • +
+ +
Remote Host +
    +
  • gdbserver is on the path.
  • +
  • port 2345 is available to use. gdbserver will use this port.
  • +
+ +

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.

+
+ + + \ No newline at end of file diff --git a/rse/examples/org.eclipse.rse.remotecdt/toc.xml b/rse/examples/org.eclipse.rse.remotecdt/toc.xml new file mode 100644 index 00000000000..1b2611151af --- /dev/null +++ b/rse/examples/org.eclipse.rse.remotecdt/toc.xml @@ -0,0 +1,16 @@ + + + + + + \ No newline at end of file