Skip to content

Commit 5a72177

Browse files
author
automatic-merge
committed
Merge remote branch 'origin/master' into edge
2 parents 51dd471 + 62cf6a6 commit 5a72177

File tree

5 files changed

+338
-377
lines changed

5 files changed

+338
-377
lines changed

doc/traces.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,34 @@
11
# ALS Trace File
22

3-
Default trace file names are:
3+
Default traces file names are:
44

5-
* `$HOME/.als/ada_ls_traces.cfg` for the language server spawned for Ada projects/files, which produce `ada_ls_log.<timestamp>.log` log files by default.
6-
* `$HOME/.als/gpr_ls_traces.cfg` for the language server spawned for GPR project files, which produce `gpr_ls_log.<timestamp>.log` log files by default.
5+
* For versions **< 24.0.6**:
76

8-
These files gets automatically created if not present on the disk. The first line of the
9-
traces files defines the traces output stream (a filename in our case) and the other
10-
lines are used to enable or disable traces.
7+
You will need to create a traces file manually under `$HOME/.als/traces.cfg`. You can
8+
use the following contents as a starter:
9+
10+
```text
11+
>ada_ls_log.$T.log:buffer_size=0
12+
ALS.MAIN=yes
13+
ALS.IN=no
14+
ALS.OUT=no
15+
```
16+
17+
This will produce `ada_ls_log.<timestamp>.log` log files for each Ada Language Server instance
18+
that gets spawned, either for Ada code or GPR files.
19+
20+
* For the **24.0.6** version:
21+
22+
Default traces file name is `$HOME/.als/traces.cfg`. This file gets automatically created
23+
if not present on the disk.
24+
25+
* For versions **> 24.0.6**:
26+
1. `$HOME/.als/ada_ls_traces.cfg` for the language server spawned for Ada code, which produce `ada_ls_log.<timestamp>.log` log files by default.
27+
2. `$HOME/.als/gpr_ls_traces.cfg` for the language server spawned for GPR files, which produce `gpr_ls_log.<timestamp>.log` log files by default.
28+
29+
These files gets automatically created if not present on the disk.
30+
31+
The first line of the traces files defines the traces output stream (a filename in our case) and the other lines are used to enable or disable traces.
1132

1233
Note that you can provide another traces file via the `--tracefile=<FILE>` command line option.
1334

0 commit comments

Comments
 (0)