Skip to content

Commit eca632b

Browse files
author
Allie Crevier
committed
add more developer docs
1 parent 409db11 commit eca632b

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,7 @@ repository. Before committing, set the TOTP value in the cassette back to the va
314314
7. Add a detached signature (with the release key) for the source tarball.
315315
8. Submit the source tarball and signature via PR into this [repository](https://github.com/freedomofpress/securedrop-debian-packaging) along with the debian changelog addition. This tarball and changelog will be used by the package builder.
316316

317+
317318
## Debugging
318319

319320
To use `pdb`, add these lines:
@@ -326,3 +327,48 @@ Then you can use [`pdb` commands](https://docs.python.org/3/library/pdb.html#deb
326327

327328
Logs can be found in the `{sdc-home}/logs`. If you are debugging a version of this application installed from a deb package in Qubes, you can debug issues by looking at the log file in `~/.securedrop_client/logs/client.log`. You can also add additional log lines in the running code in
328329
`/opt/venvs/securedrop-client/lib/python3.7/site-packages/securedrop_client/`.
330+
331+
332+
### Link against a debug version of PyQt5
333+
334+
Work in progress...
335+
336+
1. Build debug version of Qt 5
337+
338+
Clone the Qt repo and build it from source following these instructions: https://wiki.qt.io/Building_Qt_5_from_Git#Getting_the_source_code. This defaults to creating a 'debug' build and installs the binaries in the current directory, avoiding the need for `make install`.
339+
340+
2. Build debug version of PyQt5 pointing it to our debug version of Qt
341+
342+
- pip install sip==5.2.0
343+
- Download PyQt5 source (make sure the version is compatible with the version of Qt you just compiled)
344+
- Set LD_LIBRARY_PATH and QTPATH to the debug version of Qt
345+
- python configure.py --qml-debug --debug
346+
- make && make install
347+
348+
3. Install debug version of PyQt5 in the Client's virtual environment
349+
350+
351+
### Find/report a Qt bug
352+
353+
1. Create a Qt account: https://login.qt.io/register
354+
2. Find or report a bug here: https://bugreports.qt.io
355+
356+
357+
## Using Qt Creator
358+
359+
1. Download the Qt installer from: https://www.qt.io/download (be sure to select the download for open source users)
360+
361+
2. Make the installer executable
362+
363+
```
364+
chmod u+x qt-unified-linux-x64-3.2.2-online.run
365+
```
366+
367+
3. Run the installer and select the which version of Qt you want installed
368+
369+
Run `apt-cache show python3-pyqt5` in `sd-app` to figure out which version of PyQt to install
370+
371+
5. Run Qt Creator
372+
373+
Make sure to select a Python 3.7 interpreter in the project's build & run settings.
374+
>>>>>>> add more developer docs

0 commit comments

Comments
 (0)