1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-31 08:58:11 +00:00

Profiler: Add help documentation

This commit is contained in:
Brendan Coles 2021-02-24 15:40:36 +00:00 committed by Andreas Kling
parent 8f867df31a
commit 0ffc06b795
3 changed files with 61 additions and 1 deletions

View file

@ -0,0 +1,47 @@
## Name
Profiler - Serenity process profiler
## Synopsis
```**sh
$ Profiler [--pid PID] [perfcore file]
```
## Description
Profiler facilitates process performance profiling and provides a GUI offering
visual graph and tree representations to easily navigate generated profiling
information.
If no arguments are provided, a window containing a list of running processes
is presented, allowing a process to be selected for profiling.
Profiling information is written to `perfcore.<pid>` in the working directory
and opened immediately for browsing following termination of profiling.
Profiler can also load performance information from previously created
`perfcore` files.
## Options
* `-p PID`, `--pid PID`: PID to profile
## Examples
Profile running Shell process:
```sh
$ Profiler -p $(pidof Shell)
```
Open a previously created perfcore file for browsing:
```sh
$ Profiler perfcore.123
```
## See also
* [`perfcore`(5)](../man5/perfcore.md)