Add capability to list more than one method to be verbose, document some internal APIs, update man page with more explanations (#6426)

1 files changed, 43 insertions, 1 deletions

diff --git a/man/mono.1 b/man/mono.1
index 5cac78c20ae..9ac128167c7 100644
--- a/man/mono.1
+++ b/man/mono.1
@@ -65,6 +65,45 @@ and
 See the description for 
 .B MONO_IOMAP
 in the environment variables section for more details.
+.SH METHOD DESCRIPTIONS
+A number of diagnostic command line options take as argument a method
+description.   A method description is a textual representation that
+can be used to uniquely identify a method.   The syntax is as follows:
+.nf
+[namespace]classname:methodname[(arguments)]
+.fi
+.PP
+The values in brackets are optional, like the namespace and the
+arguments.   The arguments themselves are either empty, or a
+comma-separated list of arguments.   Both the
+\fBclassname\fR
+and
+\fBmethodname\fR
+can be set to the special value '*' to match any values (Unix shell
+users should escape the argument to avoid the shell interpreting
+this).
+.PP
+The arguments, if present should be a comma separated list of types
+either a full typename, or for built-in types it should use the
+low-level ILAsm type names for the built-in types,
+like 'void', 'char', 'bool', 'byte', 'sbyte', 'uint16', 'int16', 'uint',
+'int', 'ulong', 'long', 'uintptr', 'intptr', 'single', 'double', 'string', 'object'.
+.PP
+Pointer types should be the name of the type, followed by a '*',
+arrays should be the typename followed by '[' one or more commas (to
+indicate the rank of the array), and ']'.
+.PP
+Generic values should use '<', one or more type names, separated by
+both a comma and a space and '>'.
+.PP
+By-reference arguments should include a "&" after the typename.
+.PP
+Examples:
+.nf
+*:ctor(int)		// All constructors that take an int as an argument
+*:Main			// Methods named Main in any class
+*:Main(string[])	// Methods named Main that take a string array in any class
+.fi
 .SH RUNTIME OPTIONS
 The following options are available:
 .TP
@@ -1826,7 +1865,10 @@ for example, to see managed frame names on gdb backtraces.
 \fBMONO_VERBOSE_METHOD\fR
 Enables the maximum JIT verbosity for the specified method. This is
 very helpfull to diagnose a miscompilation problems of a specific
-method.
+method.   This can be a comma-separated list of method names to
+match.  If the name is simple, this applies to any method with that
+name, otherwise you can use a mono method description (see the section
+METHOD DESCRIPTIONS).
 .TP
 \fBMONO_JIT_DUMP_METHOD\fR
 Enables sending of the JITs intermediate representation for a specified