Skip to content

fix some typos in BUILDING.md #1406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ilovemikael wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix some typos in BUILDING.md #1406

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ mkdir build # The build directory may be changed, however tasks.json assumes it
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchain-x86_64-linux-gnu.cmake -DLLDB_PACKAGE=${path to LLDB package}
```
On other platforms, alter the toolchain file path accordingly. You *will* get linker errors if you don't use the toolchain file.
On other platforms, alter the toolchain file path accordingly. You *will* get linker errors if you don't use the toolchain file.

If building LLDB from source, you can also do this:
```bash
Expand All @@ -36,7 +36,7 @@ cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchain-x86_64-linux-gnu.cmake -DLLDB
The last parameter may be omitted if the LLVM build directory is located in the source tree.

## VSCode
If you intend to run and debug tests in VSCode, you may want to create a symlink from `<souce>/.cargo/config.toml`
If you intend to run and debug tests in VSCode, you may want to create a symlink from `<source>/.cargo/config.toml`
to `<build>/.cargo/config.toml`.

# Build
Expand All @@ -61,17 +61,17 @@ ctest -V -R ${regex} # Run test(s) matching the regex

## Running tests under debugger
- Launch codelldb under the debugger with `--multi-session --port=4711`.
- Run tests with the following environment variable set: `LLDB_SERVER=4711`. For example: `LLDB_SERVER=4711 make check`.
- Run tests with the following environment variable set: `LLDB_SERVER=4711`. For example: `LLDB_SERVER=4711 make check`.

## Useful targets:
- `dev_debugging` - build extension, adapter, debuggee and other stuff needed for debugging extension directly out of
the build directory. After building this target you can run `code --extensionDevelopmentPath=${workspaceFolder}/build`
to try out the extension.
- `dev_debugging` - build extension, adapter, debuggee and other stuff needed for debugging the extension directly out of
the build directory. After building this target you can run `code --extensionDevelopmentPath=${workspaceFolder}/build`
to try out the extension.
- `adapter` - build the debug adapter.
- `extension` - build VSCode extension.
- `debuggee` - build debuggee subproject (used for testing).
- `tests` - build extension tests.
- `check` - run all tests.
- `vsix_bootstrap` - build VSIX package containing only the VSCode extension.
- `vsix_full` - build VSIX package including all required native binaries (for the current platform).
- `xclean` - extra-thorough cleaning. Useful in cases of build problems caused by stale dependencies.
- `xclean` - extra-thorough cleaning. Useful in cases of build problems caused by stale dependencies.