Skip to content

Commit 38838b3

Browse files
committed
8307480: Improve SA "transported core" documentation for windows
Reviewed-by: sspitsyn, kevinw, poonam
1 parent 9842ff4 commit 38838b3

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

src/jdk.hotspot.agent/doc/transported_core.html

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,35 @@ <h3>Using transported core dumps on Windows</h3>
7676
is setup:
7777
</p>
7878

79-
<p>
79+
<code>
8080
set PATH=%JAVA_HOME%\bin;%JAVA_HOME%\bin\server;%PATH%
81-
</p>
81+
</code>
8282

8383
<p>
8484
You can also include user JNI libraries in <b>PATH</b>.
8585
If the windows libraries are not identical, then they may also need to be copied
8686
to the debugger machine and included in <b>PATH</b>.
8787
</p>
8888

89+
<p>
90+
By default symbols are also located using <b>PATH</b>. However, there are also Java properties that can be used to specify both the location of the binaries, and also separately the location of symbols. Use <b>sun.jvm.hotspot.debugger.windbg.imagePath</b> for the location of binaries, and use <b>sun.jvm.hotspot.debugger.windbg.symbolPath</b> for the location of symbols. <b>imagePath</b> defaults to <b>PATH</b> if not set, and <b>symbolPath</b> defaults to <b>imagePath</b>. The advantage of using these propeties is that you don't need to change your <b>PATH</b> setting, and they allow for binaries to be located separately from symbols.
91+
</p>
92+
93+
<p>
94+
How you set these properties will depend on the SA tool being used. The following example demonstrates how to set one of the properties when launching the clhsdb tool:
95+
</p>
96+
97+
<code>
98+
jhsdb -J-Dsun.jvm.hotspot.debugger.windbg.imagePath="%PATH%;D:\SomePath" clhsdb
99+
</code>
100+
101+
<p>If you are not seeing symbols for Windows libraries, try setting <b>sun.jvm.hotspot.debugger.windbg.symbolPath</b> to include "<b>srv*https://msdl.microsoft.com/download/symbols</b>". Also include <b>PATH</b> so SA will still find your JVM and JNI symbols. For example:
102+
</p>
103+
104+
<code>
105+
jhsdb -J-Dsun.jvm.hotspot.debugger.windbg.symbolPath="%PATH%;srv*https://msdl.microsoft.com/download/symbol" clhsdb
106+
</code>
107+
89108
<h3>Using transported core dumps on macOS</h3>
90109
<p>
91110
SA normally uses the path to the specified java executable to locate the JDK libraries. It will look

0 commit comments

Comments
 (0)