Skip to content

Commit b00e7ca

Browse files
committed
[GR-43128] Remove docs on NI debugging in VS Code based on EE debuginfo.
PullRequest: graal/13420
2 parents 23d70b8 + 5c8f4ad commit b00e7ca

File tree

12 files changed

+23
-159
lines changed

12 files changed

+23
-159
lines changed

docs/reference-manual/native-image/Compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Mostly all Native Image features are supported on Linux ARM 64-bit architecture,
113113

114114
Find a complete list of options to the `native-image` builder [here](BuildOptions.md).
115115

116-
### Further Reading
116+
### Related Documentation
117117

118118
* [Class Initialization in Native Image](ClassInitialization.md)
119119
* [Reachability Metadata](ReachabilityMetadata.md)

docs/reference-manual/native-image/DebugInfo.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -994,3 +994,7 @@ When `callgrind` is used in combination with a viewer like
994994
`kcachegrind` it is possible to identify a great deal of valuable
995995
information about native image execution aand relate it back to
996996
specific source code lines.
997+
998+
### Related Documentation
999+
1000+
- [Debug Native Executables with GDB](guides/debug-native-executables-with-gdb.md)

docs/reference-manual/native-image/Debugging.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/reference-manual/native-image/DebuggingAndDiagnostics.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ permalink: /reference-manual/native-image/debugging-and-diagnostics/
99

1010
Native Image provides utilities for debugging and inspecting the produced binary:
1111
- For debugging produced binaries and obtaining performance profile statistics, see [Debug Information](DebugInfo.md)
12-
- For Java-like debugging of native executables in a running state, see [Debugging Native Executables](Debugging.md)
1312
- For generating heap dumps, see [Heap Dump Support](guides/create-heap-dump-from-native-executable.md)
1413
- For JFR events recording, see [JDK Flight Recorder (JFR)](JFR.md)
1514
- For checking which methods were included in a native executable or a shared library, use the [Inspection Tool](InspectTool.md)
16-
- For an overview of static analysis results, see [Static Analysis Reports](StaticAnalysisReports.md)
15+
- For an overview of static analysis results, see [Static Analysis Reports](StaticAnalysisReports.md)

docs/reference-manual/native-image/guides/debug-native-executables-with-gdb.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,7 @@ A generated native executable is heavily optimized code with minimal symbol info
1111
This can be solved by embedding debug information into the resulting binary at build time.
1212
This information tells the debugger precisely how to interpret the machine code and point it back to the original Java method.
1313

14-
If your Java application deployed as a native executable behaves differently than expected, you can interactively debug a running process:
15-
16-
- using the standard Linux GNU Debugger (GDB);
17-
- using the built-in Java debugging in VS Code enabled with the [GraalVM Tools for Java extension](https://marketplace.visualstudio.com/items?itemName=oracle-labs-graalvm.graalvm).
18-
19-
In this guide you will learn how to debug a native executable using GDB.
14+
In this guide you will learn how to debug a native executable using the standard Linux GNU Debugger (GDB).
2015

2116
> Note: Native Image debugging with GDB currently works on Linux with initial support for macOS. The feature is experimental.
2217
@@ -128,5 +123,4 @@ Read more about Native Image debugging support from the [reference documentation
128123

129124
### Related Documentation
130125

131-
- [Debug Info Feature](../DebugInfo.md)
132-
- [Debug a running native image process from VS Code](../../../tools/vscode/graalvm/native-image-debugging.md)
126+
- [Debug Info Feature](../DebugInfo.md)
Binary file not shown.
Binary file not shown.

docs/tools/vscode/graalvm/README.md

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ A dialogue window suggests these options:
4343
* **Download & Install GraalVM**
4444
* **Add Existing GraalVM**
4545

46-
<img src="images/graalvm_install_actions.png" alt="GraalVM Install Dialog" style="width: 50%;">
46+
![GraalVM Install Dialog](images/graalvm_install_actions.png)
4747

4848
The **Download & Install GraalVM** action is recommended as it eliminates the fuss around setting up environment variables for you.
4949

@@ -72,11 +72,11 @@ The wizard downloads the package from [Github](https://github.com/graalvm/graalv
7272

7373
Once the installation completes, the **Install Optional GraalVM Components** window pops up prompting you to install additional language runtimes and utilities (Native Image, JavaScript, Node.js, LLVM, Python, Ruby, etc.) to the core package:
7474

75-
<img src="images/install_optional_components_popup.png" alt="Install Optional GraalVM Components" style="width: 50%;">
75+
![Install Optional GraalVM Components](images/install_optional_components_popup.png)
7676

7777
Once you confirm, you are taken to the selection list:
7878

79-
<img src="images/install_components_action.png" alt="Select Components to Install" style="width: 50%;">
79+
![Select Components to Install](images/install_components_action.png)
8080

8181
### Download and Install GraalVM Enterprise
8282

@@ -91,8 +91,8 @@ Follow these steps to download and install GraalVM Enterprise:
9191
5. Provide a valid email address where the license should be sent or enter the existing download token.
9292
Supposedly, this is your first installation and you have not accepted the license yet.
9393
Press `Enter`. Once the email address is entered, you see this popup in the bottom right corner:
94-
95-
<img src="images/continue_download_gds.png" alt="Continue Download popup" style="width: 50%;">
94+
95+
![Continue Download popup](images/continue_download_gds.png)
9696

9797
You are sent an email to verify your email address and accept the license.
9898

@@ -102,15 +102,14 @@ Follow these steps to download and install GraalVM Enterprise:
102102

103103
8. Return to VS Code and press **Continue Download** to continue. Your download token is then generated and saved by default in the `.gu/config` file in user's home directory (you can update the storage location later, see below).
104104

105-
106-
<img src="images/download_token_generated.png" alt="Download Token generated" style="width: 50%;">
105+
![Download Token generated](images/download_token_generated.png)
107106

108107
The download and installation of GraalVM Enterprise starts.
109108
The installation wizard downloads a package from Oracle's storage point.
110109

111110
If you clicked **Continue Download** without accepting the license, you would see the following warning:
112111

113-
<img src="images/continue_download_not_accepted.png" alt="Continue Download without license acceptance" style="width: 50%;">
112+
![Continue Download without license acceptance](images/continue_download_not_accepted.png)
114113

115114
> Note: If your machine is behind a proxy, you must set your environment variables (`http_proxy`, `https_proxy`) appropriately. You can use the quick command **Setup Proxy**.
116115
@@ -124,11 +123,11 @@ Once copied you can re-use the download token, for example, (1) to install Graal
124123

125124
1. Go to **View**, then **Command Palette** and search for **GraalVM: Show GU Configuration**:
126125

127-
<img src="images/show_gu_config.png" alt="Show Download Configuration action" style="width: 50%;">
126+
![Show Download Configuration action](images/show_gu_config.png)
128127

129128
2. Click **GraalVM: Show GU Configuration**. You see the popup window with a similar content:
130129

131-
<img src="images/gu_config_window.png" alt="Download Configuration window" style="width: 50%;">
130+
![Download Configuration window](images/gu_config_window.png)
132131

133132
3. Copy the download token.
134133

@@ -140,7 +139,7 @@ If you would like to define a custom file containing a download token, you can d
140139
2. Open the GraalVM for Java extension settings and find the **GU** field.
141140
3. Provide a custom file containing the download token:
142141

143-
<img src="images/define_custom_path.png" alt="Download Configuration window" style="width: 50%;">
142+
![Download Configuration window](images/define_custom_path.png)
144143

145144
## Set Default Java Runtime
146145

@@ -150,7 +149,7 @@ When the installation is complete, the **Set Default Java** action is invoked.
150149

151150
2. Select both **Set as JAVA for Terminal** options (`JAVA_HOME` and `PATH`) in the **Configure active GraalVM** window:
152151

153-
<img src="images/set_as_java_for_terminal.png" alt="Set as JAVA for Terminal" style="width: 50%;">
152+
![Set as JAVA for Terminal](images/set_as_java_for_terminal.png)
154153

155154
Alternatively, you can invoke the same action from **View**, then **Command Palette** (use the `Ctrl+Shift+P` hot keys combination for Linux, and `Command+Shift+P` for macOS to open the commands palette), and search for "GraalVM".
156155
You see **GraalVM: Set Active GraalVM Installation** among other actions.
@@ -172,7 +171,7 @@ VisualVM brings powerful yet easy-to-use visual Java tooling to VS Code.
172171
When you run a Java application, the process ID is detected automatically and displayed in the **VISUALVM** pane.
173172
Open VisualVM by just clicking the play button:
174173

175-
<img src="images/open_visualvm.png" alt="VisualVM and VS Code Integration" style="width: 50%;">
174+
![VisualVM and VS Code Integration](images/open_visualvm.png)
176175

177176
For more information, see the [dedicated guide](visualvm-integration.md) how to start using VisualVM from within VS Code.
178177

@@ -186,7 +185,7 @@ Thanks to [GraalVM Tools for Java](https://marketplace.visualstudio.com/items?it
186185

187186
GraalVM Tools for Java extension provides the **NATIVE IMAGE** with **Agent** pane to automate the process of tracking and registering dynamic feature calls, making it easier to configure and build a native executable in VS Code. The [tracing agent](../../../reference-manual/native-image/AutomaticMetadataCollection.md) tracks dynamic feature calls whilst your application is running on a JVM, and records those calls into JSON configuration files.
188187

189-
<img src="images/ni_agent_pane.png" alt="Native Image Agent pane" style="width: 50%;">
188+
![Native Image Agent pane](images/ni_agent_pane.png)
190189

191190
> Note: The **NATIVE IMAGE** pane shows up when you open your Java project in VS Code.
192191
@@ -203,7 +202,7 @@ To build a native executable of your Java application in VS Code, do the followi
203202

204203
Select **enabled** so the Native Image agent starts with the Java process:
205204

206-
<img src="images/enable_ni_agent.png" alt="Enable Native Image Agent state" style="width: 50%;">
205+
![Enable Native Image Agent state](images/enable_ni_agent.png)
207206

208207
> Note: The state is not remembered: if you close the VS Code window, it will change back to **disabled**.
209208
@@ -240,7 +239,7 @@ For Windows users, the extension provides a pre-configured x64 command prompt us
240239

241240
1. In the **NATIVE IMAGE** pane, click on right arrow, **>**:
242241

243-
<img src="images/ni_pane_windows.png" alt="NATIVE IMAGE page on Windows" style="width: 50%;">
242+
![NATIVE IMAGE page on Windows](images/ni_pane_windows.png)
244243

245244
It opens a dialog window asking you to select an existing Windows SDK build tools configuration script (`vcvars64.bat`) from the default installation location, or to select a custom configuration script. VS Code detects the script and pre-populate the path.
246245

@@ -257,17 +256,6 @@ For Windows users, the extension provides a pre-configured x64 command prompt us
257256

258257
Learn more about GraalVM Native Image [here](../../../reference-manual/native-image/README.md).
259258

260-
### Debugging
261-
262-
The GraalVM Tools for Java provide Java-like debugging of a native executable in a running state directly from within VS Code.
263-
You can set breakpoints, inspect the state of your application, even attach the debugger to a native image process in VS Code and step over the Java application source code.
264-
265-
<img src="images/debugging_ni_vscode.png" alt="Native Image Debugging in VS Code">
266-
267-
> Note: To debug a native executable from within VS Code, you must install GraalVM Enterprise.
268-
269-
Learn more and find a demo application in the [Native Image Debugging guide](native-image-debugging.md).
270-
271259
## Extension Settings
272260

273261
The GraalVM Tools for Java extension contributes the following settings in VS Code:
-197 KB
Binary file not shown.
-17.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)