Difference between revisions of "PTP/developer notes"

From Eclipsepedia

< PTP
Jump to: navigation, search
(New page: = Developer Notes = == Enabling Tracing == Enabling tracing will cause PTP's Environment Management plug-ins to write additional information to the console as Eclipse/PTP is running, w...)
 
Line 3: Line 3:
 
== Enabling Tracing  ==
 
== Enabling Tracing  ==
  
Enabling tracing will cause PTP's Environment Management plug-ins to write additional information to the console as Eclipse/PTP is running, which can be useful for diagnosing problems when PTP does not appear to be interacting correctly with a remote environment management system. &nbsp;This is available in PTP 6.0 RC3 and later. &nbsp;To enable tracing:
+
Enabling tracing will cause PTP's Environment Management plug-ins to write additional information to the console as Eclipse/PTP is running, which can be useful for diagnosing problems when PTP does not appear to be interacting correctly with a remote environment management system. &nbsp;This is available in PTP 6.0 RC3 and later. &nbsp;To enable tracing:  
  
 +
<br>
  
 
+
1. From a terminal, start Eclipse with the -debug command line argument. &nbsp;For example:  
1. From a terminal, start Eclipse with the -debug command line argument. &nbsp;For example:
+
 
<pre>cd /path/to/eclipse
 
<pre>cd /path/to/eclipse
 
./eclipse -debug
 
./eclipse -debug
</pre>
+
</pre>  
Eclipse will write several lines of output to the terminal as Eclipse starts. &nbsp;The last few lines will look something like the following.
+
Eclipse will write several lines of output to the terminal as Eclipse starts. &nbsp;The last few lines will look something like the following.  
 
<pre>Splash location:
 
<pre>Splash location:
 
     /path/to/eclipse/plugins/org.eclipse.platform_4.2.0.v201205311500/splash.bmp
 
     /path/to/eclipse/plugins/org.eclipse.platform_4.2.0.v201205311500/splash.bmp
Line 19: Line 19:
 
Starting application: 8467
 
Starting application: 8467
  
</pre>
+
</pre>  
2. Close Eclipse.
+
2. Close Eclipse.  
 
+
 
+
  
4. Using your favorite text editor, create the .options file at the path indicated in the output. &nbsp;The .options file should contain only one line:
+
3. Using your favorite text editor, create the .options file at the path indicated in the output. &nbsp;The .options file should contain only one line:  
<pre>org.eclipse.ptp.ems.core/debug = true</pre>
+
<pre>org.eclipse.ptp.ems.core/debug = true</pre>  
5. Now, start Eclipse with the -debug argument again. &nbsp;This time, it should find the .options file, since you just created it.
+
4. Now, start Eclipse with the -debug argument again. &nbsp;This time, it should find the .options file, since you just created it.  
 
<pre>Splash location:
 
<pre>Splash location:
 
     /path/to/eclipse/plugins/org.eclipse.platform_4.2.0.v201205311500/splash.bmp
 
     /path/to/eclipse/plugins/org.eclipse.platform_4.2.0.v201205311500/splash.bmp
Line 34: Line 32:
 
Starting application: 1463
 
Starting application: 1463
  
</pre>
+
</pre>  
6. Now, as you interact with the Environment Management project properties page or build a project with Environment Management enabled, watch the terminal. &nbsp;It will display status updates as it attempts to execute Modules/SoftEnv commands on the remote machine. &nbsp;For example:
+
5. Now, as you interact with the Environment Management project properties page or build a project with Environment Management enabled, watch the terminal. &nbsp;It will display status updates as it attempts to execute Modules/SoftEnv commands on the remote machine. &nbsp;For example:  
 
<pre>Running remote command; clean exit not required:
 
<pre>Running remote command; clean exit not required:
 
[0] bash
 
[0] bash
Line 55: Line 53:
 
- Lines read: 40
 
- Lines read: 40
 
- Remote process destroyed
 
- Remote process destroyed
</pre>
+
</pre>  
For more information, see [http://wiki.eclipse.org/FAQ_How_do_I_use_the_platform_debug_tracing_facility%3F FAQ: How do I use the platform debug tracing facility?]
+
For more information, see [http://wiki.eclipse.org/FAQ_How_do_I_use_the_platform_debug_tracing_facility%3F FAQ: How do I use the platform debug tracing facility?]  
  
 
[[Category:PTP]]
 
[[Category:PTP]]

Revision as of 10:37, 13 June 2012

Developer Notes

Enabling Tracing

Enabling tracing will cause PTP's Environment Management plug-ins to write additional information to the console as Eclipse/PTP is running, which can be useful for diagnosing problems when PTP does not appear to be interacting correctly with a remote environment management system.  This is available in PTP 6.0 RC3 and later.  To enable tracing:


1. From a terminal, start Eclipse with the -debug command line argument.  For example:

cd /path/to/eclipse
./eclipse -debug

Eclipse will write several lines of output to the terminal as Eclipse starts.  The last few lines will look something like the following.

Splash location:
    /path/to/eclipse/plugins/org.eclipse.platform_4.2.0.v201205311500/splash.bmp
'''Debug options:
    file:/path/to/eclipse/Eclipse.app/Contents/MacOS/.options not found
'''Time to load bundles: 22
Starting application: 8467

2. Close Eclipse.

3. Using your favorite text editor, create the .options file at the path indicated in the output.  The .options file should contain only one line:

org.eclipse.ptp.ems.core/debug = true

4. Now, start Eclipse with the -debug argument again.  This time, it should find the .options file, since you just created it.

Splash location:
    /path/to/eclipse/plugins/org.eclipse.platform_4.2.0.v201205311500/splash.bmp
'''Debug options:
    file:/path/to/eclipse/Eclipse.app/Contents/MacOS/.options loaded
'''Time to load bundles: 3
Starting application: 1463

5. Now, as you interact with the Environment Management project properties page or build a project with Environment Management enabled, watch the terminal.  It will display status updates as it attempts to execute Modules/SoftEnv commands on the remote machine.  For example:

Running remote command; clean exit not required:
[0] bash
[1] --login
[2] -c
[3] module help
- Remote process terminated with exit code 0
- Lines read: 40
- Remote process destroyed
Running remote command; clean exit not required:
[0] bash
[1] --login
[2] -c
[3] module avail -t
- Remote process terminated with exit code 0
- Lines read: 40
- Remote process destroyed
- Remote process terminated with exit code 0
- Lines read: 40
- Remote process destroyed

For more information, see FAQ: How do I use the platform debug tracing facility?