summaryrefslogtreecommitdiff
path: root/doc/contributing.asciidoc
diff options
context:
space:
mode:
authorarza <arza@arza.us>2019-09-25 00:25:43 +0300
committerarza <arza@arza.us>2019-10-03 08:56:08 +0300
commit23942e30b387b14fcab336c1ce6637f2bd535cd5 (patch)
tree25da532de42e9f644f5df9a4238904823112f89c /doc/contributing.asciidoc
parent96b76190cff8fa5a1d1c2983f1dfce92d4488532 (diff)
downloadqutebrowser-23942e30b387b14fcab336c1ce6637f2bd535cd5.tar.gz
qutebrowser-23942e30b387b14fcab336c1ce6637f2bd535cd5.zip
Improve contributing.asciidoc for run_profile.py
Diffstat (limited to 'doc/contributing.asciidoc')
-rw-r--r--doc/contributing.asciidoc18
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/contributing.asciidoc b/doc/contributing.asciidoc
index 84e9a17d0..4d0cedbeb 100644
--- a/doc/contributing.asciidoc
+++ b/doc/contributing.asciidoc
@@ -183,17 +183,21 @@ tox -e py35-cov -- tests/unit/browser/test_webelem.py
Profiling
~~~~~~~~~
-In the _scripts/_ subfolder there's a `run_profile.py` which profiles the code
-and shows a graphical representation of what takes how much time.
+In the _scripts/dev/_ subfolder there's `run_profile.py` which profiles the
+code and shows a graphical representation of what takes how much time.
It uses the built-in Python
-https://docs.python.org/3.6/library/profile.html[cProfile] module and can show
-the output in four different ways:
+https://docs.python.org/3/library/profile.html[cProfile] module. It launches a
+qutebrowser instance, waits for it to exit and then shows the graph.
-* Raw profile file (`--profile-tool=none`)
+Available methods for visualization are:
+
+* https://jiffyclub.github.io/snakeviz/[SnakeViz] (`--profile-tool=snakeviz`, the default)
* https://pypi.python.org/pypi/pyprof2calltree/[pyprof2calltree] and http://kcachegrind.sourceforge.net/html/Home.html[KCacheGrind] (`--profile-tool=kcachegrind`)
-* https://jiffyclub.github.io/snakeviz/[SnakeViz] (`--profile-tool=snakeviz`)
-* https://github.com/jrfonseca/gprof2dot[gprof2dot] (needs `dot` from http://graphviz.org/[Graphviz] and http://feh.finalrewind.org/[feh])
+* https://github.com/jrfonseca/gprof2dot[gprof2dot] (`--profile-tool=gprof2dot`, needs `dot` from http://graphviz.org/[Graphviz] and http://feh.finalrewind.org/[feh])
+* https://github.com/nschloe/tuna[tuna] (`--profile-tool=tuna`)
+
+You can also save the binary profile data to a file (`--profile-tool=none`).
Debugging
~~~~~~~~~