AuroraMiddleware/skia2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
3e5e2f2c95
skia2/site/dev/tools/debugger.md

30 lines
803 B
Markdown
Raw Normal View History

Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
Skia Debugger
=============
Introduction
------------
The Skia Debugger is a graphical tool used to step through and analyze the
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
2016-07-06 13:10:25 +00:00
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.
Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
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
2016-07-06 13:10:25 +00:00
Building and running locally
Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
--------------------
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
2016-07-06 13:10:25 +00:00
Begin by following the instructions to
[download and build Skia](../../user/quick), then simply build and run the
`skiaserve` tool:
Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
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
2016-07-06 13:10:25 +00:00
<!--?prettify lang=sh?-->
Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
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
2016-07-06 13:10:25 +00:00
# Build.
Fix typo BUG=skia: GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2370003002 NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=2370003002 Review-Url: https://codereview.chromium.org/2370003002
2016-09-26 19:49:06 +00:00
ninja -C out/Release skiaserve
Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
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
2016-07-06 13:10:25 +00:00
# Run the debugger locally
out/Release/skiaserve
Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
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
2016-07-06 13:10:25 +00:00
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`.
Adding Skia Debugger documentation BUG=skia: NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=1414393010 Review URL: https://codereview.chromium.org/1414393010
2015-11-06 19:29:06 +00:00
Update markdown to use absolute image paths, fixing broken images Markdown can be served with or without a trailing slash but when a trailing slash is present, relative image links were broken. The following example works as expected: url: https://skia.org/dev/design/pdftheory image url: PdfLogicalDocumentStructure.png resolves to: https://skia.org/dev/design/PdfLogicalDocumentStructure.png The following example was broken before this patch: url: https://skia.org/dev/design/pdftheory/ image url: PdfLogicalDocumentStructure.png resolves to: https://skia.org/dev/design/pdftheory/PdfLogicalDocumentStructure.png The PdfLogicalDocumentStructure.png file lives in /dev/design/, not /dev/design/pdftheory/. This patch updates all images in our markdown files to be served with the full path so a trailing slash no longer breaks images. I hit this bug when promoting the new Skia debugger: https://groups.google.com/a/chromium.org/d/msg/paint-dev/QJ8xpu8dNyA/F4KX2O4ZBwAJ BUG=skia:5493 GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2128013003 NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=2128013003 Review-Url: https://codereview.chromium.org/2128013003
2016-07-07 21:48:52 +00:00
![Debugger interface](/dev/tools/onlinedebugger.png)
Reference in New Issue Copy Permalink