Skip to content

Commit 78ebcd4

Browse files
Move environment setup section in user's guide
And add a sentence for remote setups. For eng/ide/ada_language_server#1705
1 parent e3063dd commit 78ebcd4

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

doc/vscode-ug.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,20 @@ Here are some links that will help you get familiar with the VS Code extension f
3636

3737
* [Tutorial: Using Ada in VS Code](./Getting-Started.md).
3838

39+
40+
## Environment Setup
41+
42+
The following environment variables influence the operation of the Ada extension:
43+
44+
* `PATH` should include the path to the GNAT compiler installation in order to benefit from auto-completion and navigation into the standard runtime.
45+
Without it, auto-completion and navigation will work only on the sources visible in the project closure, but not on the packages of the standard library `Ada.*`.
46+
47+
* `GPR_PROJECT_PATH` provides paths to other `.gpr` Ada projects that your project depends on.
48+
49+
When running VS Code locally, you can provide these environment variables by exporting them in a terminal, and starting VS Code from that same terminal with the `code` command.
50+
51+
If you are running VS Code to develop on a remote machine, please refer to the [dedicated section](#vs-code-remote) to setup your environment properly.
52+
3953
## Configuration
4054

4155
[ALS settings](./settings.md) can be specified in various ways. For example:

integration/vscode/ada/README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,6 @@ The `gnatprove` crate provides GNATprove.
5656
Both tools are available for Linux, Windows and macOS (Intel and Apple silicon)
5757
* On Windows with [msys2](https://www.msys2.org/) you can install the `gcc` and `gprbuild` packages.
5858

59-
## Environment Setup
60-
61-
The following environment variables influence the operation of the Ada extension:
62-
63-
* `PATH` should include the path to the GNAT compiler installation in order to benefit from auto-completion and navigation into the standard runtime.
64-
Without it, auto-completion and navigation will work only on the sources visible in the project closure, but not on the packages of the standard library `Ada.*`.
65-
66-
* `GPR_PROJECT_PATH` provides paths to other `.gpr` Ada projects that your project depends on.
67-
68-
When running VS Code locally, you can provide these environment variables by exporting them in a terminal, and starting VS Code from that same terminal with the `code` command.
69-
7059
## Documentation
7160

7261
* [Ada Language Server README.md: VS Code Extension](https://github.com/AdaCore/ada_language_server/blob/master/README.md#vs-code-extension)

0 commit comments

Comments
 (0)