sdk-manual: Added note for running remote apps with SSH port forw enabled.

I added the following note in the section that deals with running
Eclipse with a remote application.

Fixes [YOCTO #9276]

Currently, Eclipse does not support SSH port forwarding.
Consequently, if you need to run or debug a remote
application using the host display, you must create a
tunneling connection from outside Eclipse and keep
that connection alive during your work.
For example, in a new terminal, run the following:

     ssh -XY user_name@remote_host_ip

After running the command, add the command to be executed
in Eclipse's run configuration before the application
as follows:

     export DISPLAY=:10.0

(From yocto-docs rev: 7bf2875ff1653a8e50fa8e2bba540b2eb2512d2d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml
index d1988369225e5ba6c83e469602a1bbb102f83daa..4a8b5811fb62dadc3d3f5b03254ab85c8253f882 100644 (file)
--- a/documentation/sdk-manual/sdk-using.xml
+++ b/documentation/sdk-manual/sdk-using.xml
@@ -1261,6 +1261,23 @@
                 your application using the Eclipse IDE and then use
                 the emulator to perform debugging.
                 Follow these steps to deploy the application.
+                <note>
+                    Currently, Eclipse does not support SSH port forwarding.
+                    Consequently, if you need to run or debug a remote
+                    application using the host display, you must create a
+                    tunneling connection from outside Eclipse and keep
+                    that connection alive during your work.
+                    For example, in a new terminal, run the following:
+                    <literallayout class='monospaced'>
+     ssh -XY user_name@remote_host_ip
+                    </literallayout>
+                    After running the command, add the command to be executed
+                    in Eclipse's run configuration before the application
+                    as follows:
+                    <literallayout class='monospaced'>
+     export DISPLAY=:10.0
+                    </literallayout>
+                </note>
                 <orderedlist>
                     <listitem><para>Select "Debug Configurations..." from the
                         "Run" menu.</para></listitem>