Skip to content

docs: Add note about debugging with LLDB. #46

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

Merged
varungandhi-src merged 1 commit into from
Aug 2, 2022
Merged

docs: Add note about debugging with LLDB. #46

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
15 changes: 14 additions & 1 deletion scip-ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Some OSS repos that can be used to exercise scip-ruby are:
4. Run `./bin/brew typecheck`. An index should appear under `Library/Homebrew/`.
5. Go to step 2.

## Debugging
## Debugging with print statements

So far, I've mostly been using print debugging
(along with minimized test cases)
Expand Down Expand Up @@ -93,6 +93,19 @@ file under the `test/scip/snapshots/` directory
Having the [SCIP CLI](https://github.com/sourcegraph/scip) available
is also useful for inspecting the emitted index.

## Debugging with LLDB

Maybe there is a cleaner way to do this,
but the following works:

```
export TEST_DIR="$PWD/test/scip/testdata"
pushd bazel-out/darwin-dbg/bin
lldb -- ./test/scip_test_runner "$TEST_DIR/my_test.rb" --output="$TEST_DIR/my_test.snapshot.rb"
popd
unset TEST_DIR
```

## Creating PRs

PRs created through the GitHub UI default to being made
Expand Down