Skip to content

Commit a5cd1b4

Browse files
committed
work more on docs
1 parent a1a6155 commit a5cd1b4

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

‎docs/index.rst‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,15 @@ bottlenecks in your code.
1212

1313
vmprof works as a statistical profiler - it gathers information about your
1414
code by repeatedly getting the traceback in small intervals. This is similar
15-
to tools like `vtune`_ or `gprof`_, except it works for high-level virtual
15+
to tools like `vtune`_ or `gperftools`_, except it works for high-level virtual
1616
machines except o nthe C level.
1717

1818
The primary mode of running vmprof is through the module invocation with the
1919
API for more advanced use cases.
2020

21+
.. _`gperftools`: https://code.google.com/p/gperftools/
22+
.. _`vtune`: https://software.intel.com/en-us/intel-vtune-amplifier-xe
23+
2124
Requirements
2225
------------
2326

@@ -81,12 +84,15 @@ Options that follow ``-m vmprof`` are:
8184

8285
* ``--web URL`` - to be used together with `vmprof-server`_ or use
8386
``vmprof.baroquesoftware.com`` as URL, uploads the output to the server as
84-
JSON
87+
JSON. Can be viewed on the `demo server`_.
8588

8689
* ``-o file`` - save logs for later
8790

8891
* ``--help`` - display help
8992

93+
.. _`vmprof-server`: https://github.com/vmprof/vmprof-server
94+
.. _`demo server`: http://vmprof.baroquesoftware.com
95+
9096
There is also an API that can bring you more details to the table,
9197
but consider it unstable. The current API usage is as follows::
9298

0 commit comments

Comments
 (0)