varun-r-mallya/sysprof
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/sysprof.git synced 2025-12-31 20:36:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

help: update a few docs

Browse Source
This commit is contained in:
Christian Hergert
2023-09-01 14:35:41 -07:00
parent 6b34ea2118
commit 27ee74cb1e
1 changed files with 6 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
help/C/profiling.page
View File

@ -39,29 +39,6 @@ results</link> for more guidance.</p>
</section>
<section id="existing-process-profiling">
<info>
<link type="guide" xref="index#profiling"/>
</info>
<title>Profile an existing process</title>
<p>With <app>Sysprof</app>, you can profile one or more existing
processes on your system. First, select the <em>profiling target</em>
button next to the <em>Record</em> button. Select <em>Existing Process</em>
in the popover that is displayed. Next, select as many processes as you'd
like to profile. Processes selected for profiling will have a checkmark
next to their name.</p>
<p>After selecting your target processes, click the <em>Record</em>
button to start profiling.</p>
<p>When you have completed, click the <em>Record</em> button again
to stop profiling.</p>
<p>See <link href="profiling#interpreting-results">interpreting
results</link> for more guidance.</p>
</section>
<section id="new-process-profiling">
<info>
<link type="guide" xref="index#profiling"/>
@ -69,9 +46,10 @@ results</link> for more guidance.</p>
<title>Profile a new process</title>
<p>Often times, you may need to spawn a new process to profile.
First, select the <em>profiling target</em> button next to the
<em>Record</em> button. Next, select <em>New Process</em> and fill
out the necessary information to spawn the process.</p>
First, select the <em>Application</em> button next at the top of the
reocrding window. Fill in your command and working directory, and optionally
specify any environment variables you need. Your process will be started
when recording begins.</p>
<note>
<p>If you are spawning a process that requires access to your current
@ -92,10 +70,7 @@ command line tool. When run without any arguments, it will record your entire
system and save the output to <file>capture.syscap</file>. This file can be
opened with the <app>Sysprof</app> application to view the callgraph.</p>
<p>You can also attach to an existing process using
<cmd>sysprof-cli -p pid</cmd>.</p>
<p>If you would like to spawn a new process, use <cmd>sysprof-cli -c
<p>If you would like to spawn a new process, use <cmd>sysprof-cli --
'command'</cmd> to specify a command to be launched. The command will inherit
the current environment.</p>
@ -126,11 +101,8 @@ stacktrace.</p>
<p>On the right, are all of the decendants of a selected function. You can
select a function either from the functions list, or the callers list.</p>
<p>You can jump into a function by activating a row in the tree of descendants
with a double-click or by pressing <key>Enter</key> or <key>Spacebar</key>.</p>
<note>
<p>If you see <em>- - kernel - -</em> in your results, that means that the
<p>If you see <em>- - Context Switch - -</em> in your results, that means that the
application transitioned into or from the Linux kernel. There can be many reasons
for this such as a <em>syscall</em> or <em>signal</em>.</p>
</note>