aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/dev/tools
diff options
context:
space:
mode:
authorGravatar pdr <pdr@chromium.org>2016-07-06 06:10:25 -0700
committerGravatar Commit bot <commit-bot@chromium.org>2016-07-06 06:10:25 -0700
commit1e2a702c1959d37db734d2ecfaee0e5035b2bfbb (patch)
tree3a44f096697244f0d2c6207d166ddb90a1eadd62 /site/dev/tools
parent2dcb615c6f4822352cac1ef4dc20303ebd1ad171 (diff)
Update dev docs to reference the new skia debugger (skiaserve)
This patch adds a new markdown file describing the new debugger along with instructions on running it locally and a sweet screenshot. The screenshot has been sized to not be clipped when viewed in production. The old documentation for the qt-based debugger has been marked as deprecated and all docs referencing the old debugger have been updated. BUG=skia:5493 GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2121673002 NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=2121673002 Review-Url: https://codereview.chromium.org/2121673002
Diffstat (limited to 'site/dev/tools')
-rw-r--r--site/dev/tools/debugger.md119
-rw-r--r--site/dev/tools/onlinedebugger.pngbin0 -> 137298 bytes
-rw-r--r--site/dev/tools/qtdebugger.md120
3 files changed, 134 insertions, 105 deletions
diff --git a/site/dev/tools/debugger.md b/site/dev/tools/debugger.md
index 2f79e34d31..cd0762594c 100644
--- a/site/dev/tools/debugger.md
+++ b/site/dev/tools/debugger.md
@@ -5,116 +5,25 @@ Introduction
------------
The Skia Debugger is a graphical tool used to step through and analyze the
-contents of the Skia picture format. Pre-requisites include installing the Qt
-Library and downloading the Skia code base.
+contents of the Skia picture format. The tool is available online at
+[https://debugger.skia.org](https://debugger.skia.org/) or can be run locally.
-Qt is available here: http://qt-project.org/downloads.
-
-It can also be installed on linux using
-
-<!--?prettify?-->
-~~~~
-sudo apt-get install libqt4-dev
-~~~~
-
-Note that the debugger has been tested with Qt 4.8.6; it is known not to work
-with Qt 5.0RC1 on the Mac.
-
-Design Documents:
-
-https://docs.google.com/a/google.com/document/d/1b8muqVzfbJmYbno9nTv5721V2nlFMfnqXYLNHiSQ4ws/pub
-
-
-How to build and run
+Building and running locally
--------------------
-Because the debugger uses Qt, you'll need to build skia in 64 bit mode:
-
-<!--?prettify?-->
-
- GYP_DEFINES="skia_arch_width=64" python bin/sync-and-gyp
- ninja -C out/Debug debugger
- out/Debug/debugger
-
-For Windows, Qt ships as 32 bit libraries so to build and run one should just be
-able to:
-
-<!--?prettify?-->
-~~~~
-cd trunk
-make clean gyp
-<open solution in VS2010 and build everything>
-~~~~
-
-Depending on how your Qt is installed you may also need to define an environment
-variable like:
-
-~~~~
-GYP_DEFINES=qt_sdk='C:\Qt\4.8.6\'
-~~~~
-(which needs to be set before you execute 'make gyp')
-
-On Windows, you may need to copy several DLL and PDB files from %QTDIR%\bin into
-your executable directory (out/Debug or out/Release):
-
-QtCore4.dll QtCored4.dll QtCored4.pdb
-
-QtGui4.dll QtGuid4.dll QtGuid4.pdb
-
-QtOpenGL4.dll QtOpenGLd4.dll QtOpenGLd4.pdb
-
-
-Producing SKPs for usage
-------------------------
-
-You may either use the Skia testing images (GMs) for use in the debugger or
-create your own via chromium.
-
-To create SKPs from Chromium you must download and build chromium on your
-platform of choice: http://www.chromium.org/Home
-
-<!--?prettify?-->
-~~~~
-cd src
-make chrome
-out/Debug/chrome --no-sandbox --enable-gpu-benchmarking --force-compositing-mode
-~~~~
-
-After which go to Tools, Settings, Javascript Console and type:
-
-<!--?prettify?-->
-~~~~
-chrome.gpuBenchmarking.printToSkPicture(dirname)
-~~~~
-
-Using the Debugger
-------------------
+Begin by following the instructions to
+[download and build Skia](../../user/quick), then simply build and run the
+`skiaserve` tool:
-The debugger is fairly straight forward to use once a picture is loaded in. We
-can step through different commands via the up and down keys, and clicking on
-the command in the list. We can pause execution of commands with the pause
-button in order to inspect the details of the command in the inspector tabs
-down below.
+<!--?prettify lang=sh?-->
-
- Command | Function
- -------------|-----------------------------------------------
- x | toggles the visibility of the selected command
- alt-x | clears all hidden commands
- ctrl-x | shows all deleted commands
- b | creates a breakpoint on a command
- alt-b | clears all breakpoints
- ctrl-b | shows all breakpoints
- ctrl-r | rewinds the picture to the first command
- ctrl-p | plays to the next breakpoint or last command
- ctrl-i | Toggles the inspector and settings widgets
- ctrl-d | Toggles the directory widget
- space | Pauses drawing execution
- ctrl-o | Opens a file dialog for loading pictures
- ctrl-s | Saves the skp if you deleted any commands
- ctrl-shift-s | Saves the skp under the new specified name
- ctrl-q | Quits
+ # Build.
+ ninja -C out/Release/skiaserve
-![Debugger interface](debugger.png)
+ # Run the debugger locally
+ out/Release/skiaserve
+After running `skiaserve`, follow the instructions to open the debugger in your
+local browser. By default the address will be `http://127.0.0.1:8888`.
+![Debugger interface](onlinedebugger.png)
diff --git a/site/dev/tools/onlinedebugger.png b/site/dev/tools/onlinedebugger.png
new file mode 100644
index 0000000000..d8bfbf018c
--- /dev/null
+++ b/site/dev/tools/onlinedebugger.png
Binary files differ
diff --git a/site/dev/tools/qtdebugger.md b/site/dev/tools/qtdebugger.md
new file mode 100644
index 0000000000..e3c5a1f5b7
--- /dev/null
+++ b/site/dev/tools/qtdebugger.md
@@ -0,0 +1,120 @@
+Skia Debugger (deprecated)
+=============
+
+Introduction
+------------
+
+The Skia Debugger is a graphical tool used to step through and analyze the
+contents of the Skia picture format. Pre-requisites include installing the Qt
+Library and downloading the Skia code base.
+
+Qt is available here: http://qt-project.org/downloads.
+
+It can also be installed on linux using
+
+<!--?prettify?-->
+~~~~
+sudo apt-get install libqt4-dev
+~~~~
+
+Note that the debugger has been tested with Qt 4.8.6; it is known not to work
+with Qt 5.0RC1 on the Mac.
+
+Design Documents:
+
+https://docs.google.com/a/google.com/document/d/1b8muqVzfbJmYbno9nTv5721V2nlFMfnqXYLNHiSQ4ws/pub
+
+
+How to build and run
+--------------------
+
+Because the debugger uses Qt, you'll need to build skia in 64 bit mode:
+
+<!--?prettify?-->
+
+ GYP_DEFINES="skia_arch_width=64" python bin/sync-and-gyp
+ ninja -C out/Debug debugger
+ out/Debug/debugger
+
+For Windows, Qt ships as 32 bit libraries so to build and run one should just be
+able to:
+
+<!--?prettify?-->
+~~~~
+cd trunk
+make clean gyp
+<open solution in VS2010 and build everything>
+~~~~
+
+Depending on how your Qt is installed you may also need to define an environment
+variable like:
+
+~~~~
+GYP_DEFINES=qt_sdk='C:\Qt\4.8.6\'
+~~~~
+(which needs to be set before you execute 'make gyp')
+
+On Windows, you may need to copy several DLL and PDB files from %QTDIR%\bin into
+your executable directory (out/Debug or out/Release):
+
+QtCore4.dll QtCored4.dll QtCored4.pdb
+
+QtGui4.dll QtGuid4.dll QtGuid4.pdb
+
+QtOpenGL4.dll QtOpenGLd4.dll QtOpenGLd4.pdb
+
+
+Producing SKPs for usage
+------------------------
+
+You may either use the Skia testing images (GMs) for use in the debugger or
+create your own via chromium.
+
+To create SKPs from Chromium you must download and build chromium on your
+platform of choice: http://www.chromium.org/Home
+
+<!--?prettify?-->
+~~~~
+cd src
+make chrome
+out/Debug/chrome --no-sandbox --enable-gpu-benchmarking --force-compositing-mode
+~~~~
+
+After which go to Tools, Settings, Javascript Console and type:
+
+<!--?prettify?-->
+~~~~
+chrome.gpuBenchmarking.printToSkPicture(dirname)
+~~~~
+
+Using the Debugger
+------------------
+
+The debugger is fairly straight forward to use once a picture is loaded in. We
+can step through different commands via the up and down keys, and clicking on
+the command in the list. We can pause execution of commands with the pause
+button in order to inspect the details of the command in the inspector tabs
+down below.
+
+
+ Command | Function
+ -------------|-----------------------------------------------
+ x | toggles the visibility of the selected command
+ alt-x | clears all hidden commands
+ ctrl-x | shows all deleted commands
+ b | creates a breakpoint on a command
+ alt-b | clears all breakpoints
+ ctrl-b | shows all breakpoints
+ ctrl-r | rewinds the picture to the first command
+ ctrl-p | plays to the next breakpoint or last command
+ ctrl-i | Toggles the inspector and settings widgets
+ ctrl-d | Toggles the directory widget
+ space | Pauses drawing execution
+ ctrl-o | Opens a file dialog for loading pictures
+ ctrl-s | Saves the skp if you deleted any commands
+ ctrl-shift-s | Saves the skp under the new specified name
+ ctrl-q | Quits
+
+![Debugger interface](debugger.png)
+
+