Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 01-Sep-2019 | - | ||||
res/ | H | 01-Sep-2019 | - | 25 | 21 | |
src/ | H | 01-Sep-2019 | - | 7,733 | 6,608 | |
.gitignore | H A D | 01-Sep-2019 | 63 | 8 | 7 | |
Cargo.toml | H A D | 01-Sep-2019 | 1.2 KiB | 44 | 38 | |
README.md | H A D | 01-Sep-2019 | 1.3 KiB | 36 | 24 | |
build.rs | H A D | 01-Sep-2019 | 845 | 29 | 22 |
README.md
1# wrench 2 3`wrench` is a tool for debugging webrender outside of a browser engine. 4 5## headless 6 7`wrench` has an optional headless mode for use in continuous integration. To run in headless mode, instead of using `cargo run -- args`, use `./headless.py args`. 8 9## `replay` and `show` 10 11Binary recordings can be generated by webrender and replayed with `wrench replay`. Enable binary recording in `RendererOptions`. 12 13```rust 14RendererOptions { 15 ... 16 recorder: Some(Box::new(BinaryRecorder::new("wr-frame.bin"))), 17 ... 18} 19``` 20 21If you are working on gecko integration you can enable recording in `webrender_bindings/src/bindings.rs` by setting 22 23```rust 24static ENABLE_RECORDING: bool = true; 25``` 26 27`wrench replay --save yaml` will convert the recording into frames described in yaml. Frames can then be replayed with `wrench show`. 28 29## `reftest` 30 31Wrench also has a reftest system for catching regressions. 32* To run all reftests, run `script/headless.py reftest` 33* To run specific reftests, run `script/headless.py reftest path/to/test/or/dir` 34* To examine test failures, use the [reftest analyzer](https://hg.mozilla.org/mozilla-central/raw-file/tip/layout/tools/reftest/reftest-analyzer.xhtml) 35* To add a new reftest, create an example frame and a reference frame in `reftests/` and then add an entry to `reftests/reftest.list` 36