Valve/Proton
1
0
Fork 0
mirror of https://github.com/ValveSoftware/Proton.git synced 2025-03-12 13:30:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Change DEBUGGING.md to DEBUGGING-LINUX.md.

Browse Source
This commit is contained in:
Arkadiusz Hiler 2024-08-27 15:27:41 +03:00
parent 0d2030e75f
commit 412b489ad6
2 changed files with 34 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -218,7 +218,8 @@ need to be explicitly loaded by the debugging tools. For GDB there's a helper
script `wine/tools/gdbinit.py` (source it) that provides `load-symbol-files`
(or `lsf` for short) command which loads the symbols for all the mapped files.
For tips on debugging see [docs/DEBUGGING.md](docs/DEBUGGING.md).
For tips on debugging see [docs/DEBUGGING-LINUX.md](docs/DEBUGGING-LINUX.md)
and [docs/DEBUGGING-WINDOWS.md](docs/DEBUGGING-WINDOWS.md).
`compile_commands.json`

38
docs/DEBUGGING.md → docs/DEBUGGING-LINUX.md
View File

@ -1,14 +1,37 @@
Proton Debugging Tips
=====================
Proton Debugging Tips For Linux / Wine Developers
=================================================
For loading dev builds of games onto a Steam Deck see
<https://partner.steamgames.com/doc/steamdeck/loadgames>
Table Of Contents
-----------------
- [Debug Proton Builds](#debug-proton-builds)
- [Attaching A Debugger](#attaching-a-debugger)
- [Attaching Before The Program Starts](#attaching-before-the-program-starts)
- [Getting Shell Inside Of The Steam Runtime](#getting-shell-inside-of-the-steam-runtime)
- [Starting A Different Binary](#starting-a-different-binary)
- [Substitution](#substitution)
- [Pressure-Vessel Shell](#pressure-vessel-shell)
Debug Proton Builds
-------------------
See [README.md#debugging](../README.md#debugging).
Debug builds contain symbols and should be used for live debugging session.
1. Locate the version of proton you are using in your Steam Library (e.g. Proton
Experimental), click on a cog and select properties.
![](img/proton_properties.png)
2. In the "betas" tab select "debug - unstripped".
![](img/proton_debug_beta.png)
3. Chosen Proton version will now download and update and the symbols will be
available.
For instruction on how to make a custom debug build see
[README.md#debug-builds](../README.md#debug-builds).
Attaching A Debugger
@ -40,10 +63,11 @@ which you can build with `configure && make all-gdb && make install-gdb`.
Make sure to have python development packages installed, as GDB python
support will be required.
**NOTE: using a debug Proton build will greatly improve the experience.**
With this custom GDB you can `source` [Wine's custom unwinder](https://github.com/ValveSoftware/wine/blob/experimental_9.0/tools/gdbunwind.py)
in your `~/.gdbinit`, and you will get backtraces across PE / unix boundaries.
With older Proton you can use `source` [wine's
gdbinit](https://github.com/ValveSoftware/wine/blob/proton_8.0/tools/gdbinit.py)
to make `load-symbol-files` command available that uses `/proc/$pid/maps` to
@ -147,6 +171,7 @@ Starting A Different Binary
If you want to start a different binary than the game's default you can use a
few methods. All of the examples below will use `winecfg`.
### Substitution
You can use the following launch option:
@ -159,6 +184,7 @@ The full substitution of `proton waitforexitandrun .*` is necessary as the
original `%command%` is very long and may contain multiple mentions of `proton`
or the original binary.
### Pressure-Vessel Shell
[Pressure-vessel][pv] allows to spawn an xterm instead of launching Proton. This