Skip to content

Commit 794b541

Browse files
Merge branch 'topic/#1175' into 'master'
Do a pass on the VS Code extension walkthrough See merge request eng/ide/ada_language_server!1375
2 parents d2d099b + c8f105b commit 794b541

File tree

3 files changed

+16
-39
lines changed

3 files changed

+16
-39
lines changed
Lines changed: 13 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,27 @@
11
# 🔨 Build a project
22

3-
Use "auto-detected tasks" to
4-
* ⚙ Build whole project
3+
Use "auto-detected tasks" (i.e: `gnat` tasks in the `Run Task` dialog) to
4+
* ⚙ Build the whole project
55
* ✅ Check errors in the current file
6-
* 🔎 Lauch `gnatprove` to verify the code
6+
* 🔎 Launch `gnatprove` to verify your SPARK code, if any (you can find the tool [here](https://github.com/alire-project/GNAT-FSF-builds/releases))
77

88
## 🚀 Launch
99

10-
Use embedded terminal to launch your executable.
10+
Open a new terminal to launch your executable once it has been built.
1111

1212
## 🐞 Debug
1313

1414
The [ms-vscode.cpptools](https://github.com/microsoft/vscode-cpptools) extension
1515
is automatically installed along with this extension, allowing to use its
1616
integration for GDB to debug Ada code.
1717

18-
You will just need to add a proper debug configuration in your `launch.json`
19-
file. Let's consider a basic `.gpr` project, which produces a
20-
`main` executable in an `obj` directory:
18+
The extension provides default debug configurations for all the mains of your
19+
project. You can debug the executable of your choice by opening the
20+
`Run and Debug` panel and then by clicking on the `Run and Debug` button.
21+
You can also run directly the `Debug: Start Debugging` command instead of using the UI. In some circumstances the UI may offer a selection of languages, in which case select `Ada`.
22+
The extension will then propose you to select the main you want to debug if your project contains several mains.
2123

22-
```
23-
project Default is
24-
25-
for Main use ("main.adb");
26-
for Object_Dir use "obj";
27-
28-
end Default;
29-
30-
```
31-
32-
A basic `launch.json` file which allows to debug the produced `main`
33-
executable would be:
34-
35-
```
36-
{
37-
"name": "Ada Debugging",
38-
"type": "cppdbg",
39-
"request": "launch",
40-
"program": "${workspaceFolder}/obj/main",
41-
"cwd": "${workspaceFolder}"
42-
}
43-
44-
```
45-
46-
You will then be able to go to the `Run and Debug` VS Code panel
47-
in order to run the newly added debugger.
48-
49-
You can find more information about how to configure the debugger
50-
[here](https://code.visualstudio.com/docs/cpp/launch-json-reference).
24+
If you want to customize GDB's behavior or if you need to add custom arguments, you
25+
will have to create a `launch.json` file: this can be done through the
26+
`create a launch.json file` link button in the `Run and Debug` panel or directly via
27+
the `Debug: Add Configuration` command.

integration/vscode/ada/media/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ the extension will use the first project file found in the root project
55
folder.
66

77
⚙ You can change settings per workspace or per user: generally we recommend to
8-
change the project file setting in the desired workspace, since project files
8+
change the project file settings in the desired workspace, since project files
99
are usually workspace-specific.
1010

1111
📋 [List of Ada settings](https://github.com/AdaCore/ada_language_server/blob/master/doc/settings.md)

integration/vscode/ada/media/welcome.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ☀ Welcome to Ada!
22

3-
Take a few minutes to learn about the functionality provided by the Ada extension.
3+
Take a few minutes to learn about the features provided by the Ada extension.
44

5-
Use this extension to enable Ada/SPARK support in VS Code.
5+
Use this extension to develop in Ada/SPARK in VS Code.
66

77
📖 Take a look at our [WiKi site](https://github.com/AdaCore/ada_language_server/wiki) with tutorials and demos:
88
* [Tutorial: Using Ada in VS Code](https://github.com/AdaCore/ada_language_server/wiki/Getting-Started)

0 commit comments

Comments
 (0)