Skip to content

Commit 534d038

Browse files
committed
Add documentation about getting symbolic backtrace.
Fix `pack-binaries.sh` to avoid `.dSYM` in `.vsix`. Closes #1135.
1 parent b8298c7 commit 534d038

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

.github/workflows/pack-binaries.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function make_change_log()
1919

2020
chmod -R -v +x als-*-$DEBUG
2121
for X in Linux macOS Windows ; do mv -v -f als-$X-$DEBUG/* integration/vscode/ada/; done
22-
rm -f -v integration/vscode/ada/{linux,darwin,win32}/*.debug
22+
rm -f -v integration/vscode/ada/{linux,darwin,win32}/*.{debug,dSYM}
2323
pushd integration/vscode/ada
2424
sed -i -e "/version/s/[0-9][0-9.]*/$TAG/" package.json
2525
[ -z "$DEBUG" ] || sed -i -e '/^ "name"/s/ada/ada-debug/' \

doc/HACKING.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,22 @@ about memory usage, allowing to track down which parts of the program consumes
3636
the most memory.
3737
This is very useful to resolve unexpected memory consumption issues.
3838

39+
## Getting symbolic backtrace
40+
41+
To get a symbolic backtrace you need the debug information files. For the
42+
release you can download them from
43+
[GitHub Release](https://github.com/AdaCore/ada_language_server/releases)
44+
Assets. Assets contain an archive per platform with the ALS
45+
executable and debug information files (`.debug` file on Linux/Windows and
46+
`.dSYM` directory for Mac OS X). Extract the debug information to the directory
47+
containing ALS (usually this is
48+
`$HOME/.vscode/extensions/adacore.ada-*/{darwin,linux,win32}`)
49+
and run
50+
51+
addr2line ada_language_server <hex backtrace>
52+
53+
On Mac OX X use [atos](https://www.unix.com/man-page/osx/1/atos/) instead.
54+
3955
### Writing tests
4056

4157
To write a functional test for Ada Language Server:
@@ -116,16 +132,16 @@ Release notes
116132
```
117133
118134
Then push it to GitHub with `git push 22.0.3` or `git push --tags`.
119-
The travis CI will publish the extension on the marketplace.
135+
The GitHub CI will publish the extension on the marketplace and the
136+
[Open VSX Registry](https://open-vsx.org). It also makes GitHub Release and
137+
put archives with ALS executables and debug information files.
120138
121139
## Source directories
122140
123141
The repository contains the following folders:
124142
125143
* `doc/` - documentation of the project and LSP extensions
126144
* `gnat/` - GNAT project files
127-
* `integration/appveyor/` - Appveyor CI (Windows) integration scripts
128-
* `integration/travis/` - Travis CI (Linux and Mac OS) integration scripts
129145
* `integration/vscode/ada/` - VS Code extension sources
130146
* `scripts/` - some support scripts
131147
* `ada_language_server/source/ada/` - LSP implementation for Ada language

0 commit comments

Comments
 (0)