Skip to content

Commit e9c52d9

Browse files
committed
Merge branch 'master' of github.com:vmprof/vmprof-python
2 parents aace732 + 1d67400 commit e9c52d9

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/faq.rst

+14-1
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,24 @@ Frequently Asked Questions
77
If the symbol has been exported in the shared object (on linux), ``dladdr`` might still be able to extract
88
the function name even if no debugging information has been attached.
99

10+
* **Is it possible to just profile a part of my program?**: Yes here an example how you could do just that::
11+
12+
with open('test.prof', 'w+b') as fd:
13+
vmprof.enable(fd.fileno())
14+
my_function_or_program()
15+
vmprof.disable()
16+
17+
Upload it later to vmprof.com if you choose to inspect it further::
18+
19+
$ python -m vmprof.upload test.prof
20+
21+
22+
1023
* **What do the colors on vmprof.com mean?**: For plain CPython there is no particular meaning, we might change
1124
that in the future. For PyPy we have a color coding to show at which state the VM sampled (e.g. JIT, Warmup, ...).
1225

1326
* **My Windows profile is malformed?**: Please ensure that you open the file in binary mode. Otherwise Windows
14-
will transform `\n` to `\r\n`.
27+
will transform ``\n`` to ``\r\n``.
1528

1629
* **Do I need to install libunwind?**: Usually not. We ship python wheels that bundle libunwind shared objects. If you install vmprof from source, then you need to install the development headers of your distribution. OSX ships libunwind per default. If your pip version is really old it does not pull wheels and it will end up compiling from source.
1730

0 commit comments

Comments
 (0)