diff --git a/doc/vscode-ug.md b/doc/vscode-ug.md index c0a580eb..46ef2640 100644 --- a/doc/vscode-ug.md +++ b/doc/vscode-ug.md @@ -36,6 +36,20 @@ Here are some links that will help you get familiar with the VS Code extension f * [Tutorial: Using Ada in VS Code](./Getting-Started.md). + +## Environment Setup + +The following environment variables influence the operation of the Ada extension: + +* `PATH` should include the path to the GNAT compiler installation in order to benefit from auto-completion and navigation into the standard runtime. +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.*`. + +* `GPR_PROJECT_PATH` provides paths to other `.gpr` Ada projects that your project depends on. + +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. + +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. + ## Configuration [ALS settings](./settings.md) can be specified in various ways. For example: diff --git a/integration/vscode/ada/README.md b/integration/vscode/ada/README.md index 0a528c01..9afea0b2 100644 --- a/integration/vscode/ada/README.md +++ b/integration/vscode/ada/README.md @@ -56,17 +56,6 @@ The `gnatprove` crate provides GNATprove. Both tools are available for Linux, Windows and macOS (Intel and Apple silicon) * On Windows with [msys2](https://www.msys2.org/) you can install the `gcc` and `gprbuild` packages. -## Environment Setup - -The following environment variables influence the operation of the Ada extension: - -* `PATH` should include the path to the GNAT compiler installation in order to benefit from auto-completion and navigation into the standard runtime. -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.*`. - -* `GPR_PROJECT_PATH` provides paths to other `.gpr` Ada projects that your project depends on. - -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. - ## Documentation * [Ada Language Server README.md: VS Code Extension](https://github.com/AdaCore/ada_language_server/blob/master/README.md#vs-code-extension)