summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosé Fonseca <jose.r.fonseca@gmail.com>2011-11-29 23:25:13 +0000
committerJosé Fonseca <jose.r.fonseca@gmail.com>2011-11-29 23:25:13 +0000
commitc7cc272ddcf5dbde3361f2a9a54427a77976da89 (patch)
tree1d55390ea010ee712bd1eed6ee20c15b76c0eaa3
parentfc73ca1d4a8f177ccd84aa0c9a841c9e86c81fdc (diff)
Update docs.
-rw-r--r--DEVELOPMENT.markdown8
-rw-r--r--README.markdown32
-rw-r--r--TODO.markdown1
3 files changed, 21 insertions, 20 deletions
diff --git a/DEVELOPMENT.markdown b/DEVELOPMENT.markdown
index b64db14..5d2c052 100644
--- a/DEVELOPMENT.markdown
+++ b/DEVELOPMENT.markdown
@@ -1,8 +1,8 @@
Coding Style
============
-XXX: These are guidelines for new code. Some of existing hasn't been updated
-to these conventions yet.
+XXX: These are mostly guidelines for new code, as some of existing hasn't been
+updated to these conventions yet.
Whitespace (all languages):
@@ -75,4 +75,6 @@ Backwards compatibility:
Regression testing
==================
-Not standardized yet. Work in progress.
+There is a regression test suite under development in
+https://github.com/apitrace/apitrace-tests .
+
diff --git a/README.markdown b/README.markdown
index 497351a..f57836e 100644
--- a/README.markdown
+++ b/README.markdown
@@ -3,9 +3,9 @@ About **apitrace**
**apitrace** consists of a set of tools to:
-* trace OpenGL, D3D9, D3D8, D3D7, and DDRAW APIs calls to a file;
+* trace OpenGL, OpenGL ES, D3D9, D3D8, D3D7, and DDRAW APIs calls to a file;
-* retrace OpenGL calls from a file;
+* retrace OpenGL and OpenGL ES calls from a file;
* inspect OpenGL state at any call while retracing;
@@ -21,7 +21,7 @@ Linux and Mac OS X
Run the application you want to trace as
- /path/to/apitrace trace /path/to/application [args...]
+ apitrace trace /path/to/application [args...]
and it will generate a trace named `application.trace` in the current
directory. You can specify the written trace filename by setting the
@@ -29,18 +29,18 @@ directory. You can specify the written trace filename by setting the
View the trace with
- /path/to/apitrace dump --color application.trace | less -R
+ apitrace dump --color application.trace | less -R
-Replay the trace with
+Replay an OpenGL trace with
- /path/to/glretrace application.trace
+ glretrace application.trace
Pass the `-sb` option to use a single buffered visual. Pass `--help` to
glretrace for more options.
Start the GUI as
- /path/to/qapitrace application.trace
+ qapitrace application.trace
Windows
@@ -146,13 +146,13 @@ Dump GL state at a particular call
You can get a dump of the bound GL state at call 12345 by doing:
- /path/to/glretrace -D 12345 application.trace > 12345.json
+ glretrace -D 12345 application.trace > 12345.json
This is precisely the mechanism the GUI obtains its own state.
-You can compare two state dumps with the jsondiff.py script:
+You can compare two state dumps by doing:
- ./scripts/jsondiff.py 12345.json 67890.json
+ apitrace diff-state 12345.json 67890.json
Comparing two traces side by side
@@ -169,7 +169,7 @@ Recording a video with FFmpeg
You can make a video of the output by doing
- /path/to/glretrace -s - application.trace \
+ glretrace -s - application.trace \
| ffmpeg -r 30 -f image2pipe -vcodec ppm -i pipe: -vcodec mpeg4 -y output.mp4
@@ -189,7 +189,7 @@ These are the steps to create a regression test-suite around **apitrace**:
* obtain reference snapshots, by doing:
mkdir /path/to/snapshots/
- /path/to/glretrace -s /path/to/reference/snapshots/ application.trace
+ glretrace -s /path/to/reference/snapshots/ application.trace
on reference system.
@@ -197,12 +197,12 @@ These are the steps to create a regression test-suite around **apitrace**:
* to do a regression test, do:
- /path/to/glretrace -c /path/to/reference/snapshots/ application.trace
+ glretrace -c /path/to/reference/snapshots/ application.trace
- Alternatively, for a HTML summary, use the snapdiff script:
+ Alternatively, for a HTML summary, use `apitrace diff-images`:
- /path/to/glretrace -s /path/to/current/snapshots/ application.trace
- ./scripts/snapdiff.py --output summary.html /path/to/reference/snapshots/ /path/to/current/snapshots/
+ glretrace -s /path/to/current/snapshots/ application.trace
+ apitrace diff-images --output summary.html /path/to/reference/snapshots/ /path/to/current/snapshots/
Automated git-bisection
diff --git a/TODO.markdown b/TODO.markdown
index 4cfeab8..51afd6b 100644
--- a/TODO.markdown
+++ b/TODO.markdown
@@ -63,7 +63,6 @@ CLI
* Add trim Trim a trace by including only the specified calls/frames
* Add dump-state Output the OpenGL state in JSON format
* Add dump-images Create image files for each frame/drawing operation of a trace
-* Add diff-images Identify differences between images and another trace
* Add some common command-line options: