X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=DEVELOP.md;h=024e9d1aa7ff13894d6885261dafefe7886bc734;hb=4f81cdeb7802d2087244590a801ecc1a64eff0aa;hp=e75b4adcfd894665b077a964d3a04990e3ac8b62;hpb=3dfab77f57fb1eeea7cb19b5a4956ab06779e14a;p=dcpomatic.git diff --git a/DEVELOP.md b/DEVELOP.md index e75b4adcf..024e9d1aa 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -4,6 +4,39 @@ This file collects a few notes relevant to DCP-o-matic developers. There is als [on the web site](https://dcpomatic.com/development). +## Disk writer logging + +As we have no `film' folder to log to during disk writes, the logs end up: + +### macOS + +* Disk writer backend: `/var/log/dcpomatic_disk_writer_{out,err}.log` +* Disk writer frontend: `/Users/$USER/Library/Preferences/2/com.dcpomatic/2.16/disk.log` + +### Windows + +* Disk writer backend: `c:\Users\$USER\AppData\Local\dcpomatic\2.16.0\disk_writer.log` +* Disk writer frontend: `c:\Users\$USER\AppData\Local\dcpomatic\2.16.0\disk.log` + +### Linux + +* Disk writer backend: `/home/$USER/.config/dcpomatic/2.16.0/disk_writer.log` +* Disk writer frontend: `/home/$USER/.config/dcpomatic/2.16.0/disk.log` + + +## Branches + +The main dcpomatic repo has the following branches: + +* `main` - the main development branch; contains 2.16.x versions +* `v2.17.x` - development branch for v2.17.x versions; periodically rebased onto `main` + +The `test/data` submodule has the following branches: + +* `v2.16.x` - branch for use with v2.16.x versions +* `v2.18.x` - branch for use with v2.17.x versions (as will become v2.18.x) + + ## Player stress testing If you configure DCP-o-matic with `--enable-player-stress-test` you can make a script which @@ -59,7 +92,19 @@ to load a script file called `stress` and start executing it. - cp build/src/lib/libdcpomatic.pot src/lib/po/$LANG.po - cp build/src/wx/libdcpomatic-wx.pot src/wx/po/$LANG.po - cp build/src/tools/libdcpomatic-wx.pot src/tools/po/$LANG.po +- sed -i "s/CHARSET/UTF-8/" src/{lib,wx,tools}/po/$LANG.po - Commit / push - Add credit to `src/wx/about_dialog.cc` and database. - Add to `i18n.php` on website and `update-i18n-stats` script, then run `update-i18n-stats` script. + +## Taking screenshots for the manual + +The manual PDF looks nice if vector screenshots are used. These can be taken as follows: + +- Build `gtk-vector-screenshot.git` (using meson/ninja) +- Copy `libgtk-vector-screenshot.so` to `/usr/local/lib/gtk-3.0/modules/` +- Run DCP-o-matic using `run/dcpomatic --screenshot` +- Start `take-vector-screenshot`, click "Take screenshot" then click on the DCP-o-matic window. +- Find a PDF in `/tmp/dcpomatic2.pdf` +- Copy this to `doc/manual/raw-screenshots`