Skip to content

Commit

Permalink
Documentation: Remove now-unnecessary environment settings for VsCode
Browse files Browse the repository at this point in the history
  • Loading branch information
ADKaster committed Jul 17, 2024
1 parent e8be2bc commit 7a3789b
Showing 1 changed file with 1 addition and 26 deletions.
27 changes: 1 addition & 26 deletions Documentation/VSCodeConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,12 @@ The recommended extensions for VS Code include:

## Configuration

To be compatible with `./Meta/ladybird.sh`, we must set CC and CXX to the correct compilers for *both* configure and build. This can be done in the `.vscode/settings.json` file.

```json
{
"cmake.configureEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
"cmake.buildEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
"clangd.path": "clangd-18"
}
```

Run `./Meta/ladybird.sh build` at least once to kick off downloading and building vcpkg dependencies.

The CMake Tools plugin should automatically detect the `CMakePresets.json` at the root of the repository.
Selecting and activating the `default` preset should be enough to get started after the initial build.
You can also use the `Debug` preset to build with debug symbols, or the `Sanitizer` preset to build with ASAN/UBSAN.

If building through VsCode itself causes vcpkg to rebuild the world, verify that the environment settings match the `CMAKE_CXX_COMPILER` line in the build directory's `CMakeCache.txt`.

For additional settings recommendations, see the [Settings](#settings) section below.

## Code comprehension
Expand Down Expand Up @@ -153,14 +135,7 @@ These belong in the `.vscode/settings.json` of Serenity.
// git commit message length
"git.inputValidationLength": 72,
"git.inputValidationSubjectLength": 72,
"cmake.configureEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
"cmake.buildEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
// If clangd was obtained from a package manager, its path can be set here.
"clangd.path": "clangd-18",
"clangd.arguments": [
"--header-insertion=never" // See https://github.com/clangd/clangd/issues/1247
Expand Down

0 comments on commit 7a3789b

Please sign in to comment.