Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mono/mono.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorAlex Rønne Petersen <alpeters@microsoft.com>2017-11-28 01:08:58 +0300
committerAlex Rønne Petersen <alpeters@microsoft.com>2017-11-28 01:08:58 +0300
commit2ab06befe9979dc893961c3eb85a137cb67cb702 (patch)
tree028773bb77da01f3ddc81672b14bca549007320d /man
parent984f6484666c2ee6fefec949c81fdff1189c9488 (diff)
[profiler] Make it possible to trigger heapshots from the M.P.L library.
Also make it so on-demand heapshots can be done regardless of the heapshot mode in use. There really wasn't a good reason to not allow it before.
Diffstat (limited to 'man')
-rw-r--r--man/mono-profilers.114
1 files changed, 7 insertions, 7 deletions
diff --git a/man/mono-profilers.1 b/man/mono-profilers.1
index 97b1aced7e1..8ce00dade9a 100644
--- a/man/mono-profilers.1
+++ b/man/mono-profilers.1
@@ -167,7 +167,7 @@ Enable heap snapshots. \fImode\fR, if given, can be one of:
.TP
\fBondemand\fR
Only perform a heapshot when receiving a command via the command
-server.
+server or when triggered through the managed library.
.TP
\fInum\fR\fBgc\fR
Perform a heapshot on every \fInum\fR collections of the major
@@ -190,11 +190,11 @@ Print detailed debugging information. Most users should not use this
option.
.SS Command server
The log profiler features a simple command server that currently is
-only used to trigger heapshots when using the on-demand mode. A
-random port will be used to listen for connections unless the
-\fBport\fR option is used. To trigger a heapshot, open a TCP
-connection to the command server and send the C string
-\fB"heapshot\\n"\fR.
+only used to trigger manual heapshots (typcally when using the
+on-demand mode, but also usable with the other modes). A random port
+will be used to listen for connections unless the \fBport\fR option
+is used. To trigger a heapshot, open a TCP connection to the command
+server and send the C string \fB"heapshot\\n"\fR.
.PP
The command server supports multiple simultaneous connections.
.SS Managed library
@@ -210,7 +210,7 @@ tools (e.g., \fBmprof\-report\fR(1)).
The \fBLogProfiler\fR class allows users to reconfigure profiler
settings at run-time. For example, certain event types can be toggled
on or off, the mode and frequency of heapshots and sampling can be
-changed, etc.
+changed, etc. Heapshots can also be triggered manually.
.PP
To use this library, simply pass \fB\-r:Mono.Profiler.Log\fR when
compiling your code.