Skip to content

Commit

Permalink
Fix some typos in the readme (#113)
Browse files Browse the repository at this point in the history
* Fix typos

* Fix typo
  • Loading branch information
nobkd committed Oct 23, 2023
1 parent 4fe9c66 commit af31036
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lldb-mi uses CMake to build. The only dependencies needed for lldb-mi are a C++1

# Building against system LLDB

If your distribution or operating system already ships a correctly configured LLDB/Clang/LLVM installation, lldb-mi can be build by simply running:
If your distribution or operating system already ships a correctly configured LLDB/Clang/LLVM installation, lldb-mi can be built by simply running:


```bash
Expand All @@ -18,9 +18,9 @@ cmake --build .

# Building against custom LLDB

You can also build lldb-mi against a LLDB that you compiled yourself. For that compile LLDB as described [here](https://lldb.llvm.org/resources/build.html) but set `CMAKE_INSTALL_PREFIX` to a local directory and build the LLVM shared library by passing `-DLLVM_BUILD_LLVM_DYLIB=On` to CMake. Afterwards point towards that prefix directory when building lldb-mi by settings `CMAKE_PREFIX_PATH` (e.g. `cmake -DCMAKE_PREFIX_PATH=/home/yourname/lldb-mi/install`).
You can also build lldb-mi against a LLDB that you compiled yourself. For that, compile LLDB as described [here](https://lldb.llvm.org/resources/build.html) but set `CMAKE_INSTALL_PREFIX` to a local directory and build the LLVM shared library by passing `-DLLVM_BUILD_LLVM_DYLIB=On` to CMake. Afterwards point towards that prefix directory when building lldb-mi by setting `CMAKE_PREFIX_PATH` (e.g. `cmake -DCMAKE_PREFIX_PATH=/home/yourname/lldb-mi/install`).

This example script should build LLVM and lldb-mi on an average UNIX system in the ~/buildspace subfolder:
This example script should build LLVM and lldb-mi on an average UNIX system in the `~/buildspace` subfolder:
```
cd
mkdir buildspace
Expand Down Expand Up @@ -49,9 +49,9 @@ ninja

# Building against custom LLDB.framework (Darwin Only)

You can also build lldb-mi against a LLDB.framework that you compiled yourself. It is the same instructions as above but build the LLVM framework by passing `-DLLDB_BUILD_FRAMEWORK=1` to CMake instead of using the shared library. Then build LLDB-MI with `-DUSE_LLDB_FRAMEWORK=1`
You can also build lldb-mi against a LLDB.framework that you compiled yourself. You follow the same instructions as above but build the LLVM framework by passing `-DLLDB_BUILD_FRAMEWORK=1` to CMake instead of using the shared library. Then build lldb-mi with `-DUSE_LLDB_FRAMEWORK=1`

The snippits below change the cmake calls from the above script.
The snippets below change the CMake calls from the above script.
```
// Building llvm-project
cmake -DLLVM_ENABLE_PROJECTS="clang;lldb;libcxx;libcxxabi" -DCMAKE_INSTALL_PREFIX=~/buildspace/llvm-inst/ -DLLDB_BUILD_FRAMEWORK=1 -GNinja ../llvm-project/llvm
Expand All @@ -65,9 +65,9 @@ cmake -DCMAKE_PREFIX_PATH=~/buildspace/llvm-inst/ -DUSE_LLDB_FRAMEWORK=1 -GNinja

# Notes

On some architectures (e. g. Linux, x86-64), LLDB dinamic library fails to determine its location. That results to inability of locating a gdbserver stub:
On some architectures (e.g. Linux, x86-64), LLDB dynamic library fails to determine its location. That results in the inability to locate a gdbserver stub:
```bash
process launch failed: unable to locate lldb-server
```

The workaraund is to set LLDB_DEBUGSERVER_PATH environment variable before running LLDB-MI.
The workaround is to set `LLDB_DEBUGSERVER_PATH` environment variable before running lldb-mi.

0 comments on commit af31036

Please sign in to comment.