[svn:parrot] r49452 - trunk/src/runcore

[cotto at svn.parrot.org]

Author: cotto
Date: Tue Oct  5 19:54:36 2010
New Revision: 49452
URL: https://trac.parrot.org/parrot/changeset/49452

Log:
[profiling] improve inline pod docs

Modified:
   trunk/src/runcore/profiling.c

Modified: trunk/src/runcore/profiling.c
==============================================================================
--- trunk/src/runcore/profiling.c	Tue Oct  5 19:02:57 2010	(r49451)
+++ trunk/src/runcore/profiling.c	Tue Oct  5 19:54:36 2010	(r49452)
@@ -196,7 +196,7 @@
 
 =item C<void Parrot_runcore_profiling_init(PARROT_INTERP)>
 
-Registers the profiling runcore with Parrot.
+Register the profiling runcore with Parrot.
 
 =cut
 
@@ -343,7 +343,7 @@
 Parrot_profiling_runcore_t *runcore, opcode_t *pc)>
 
 Runs the Parrot operations starting at C<pc> until there are no more
-operations, with tracing, bounds checking, and profiling enabled.
+operations with tracing, bounds checking and profiling enabled.
 
 =cut
 
@@ -454,7 +454,7 @@
 =item C<static void record_ctx_info(PARROT_INTERP, Parrot_profiling_runcore_t
 *runcore, PPROF_DATA *pprof_data, PMC* ctx_pmc, opcode_t *pc)>
 
-When the active context has changed, record information about the new context.
+If the active context has changed, record information about the new context.
 
 =cut
 
@@ -606,7 +606,10 @@
 =item C<static void record_cli(PARROT_INTERP, Parrot_profiling_runcore_t
 *runcore, PPROF_DATA* pprof_data, PMC* argv)>
 
-Store the cli information
+Record information about CLI arguments passed to the program being profiled.
+Note that because of the way the parrot executable parses its options,
+arguments passed directly to C<parrot> (such as C<--gc ms2> or C<--hash-seed
+234>) will not appear here.
 
 =cut
 
@@ -641,7 +644,8 @@
 =item C<static char* get_ns_cstr(PARROT_INTERP, Parrot_profiling_runcore_t
 *runcore, PMC* ctx_pmc)>
 
-Get the namespace information
+Return a C string containing a human-readable representation of the namespace
+for C<ctx_pmc>.
 
 =cut
 
@@ -695,7 +699,7 @@
 =item C<static char* get_filename_cstr(PARROT_INTERP, Parrot_profiling_runcore_t
 *runcore, PMC* ctx_pmc, opcode_t *pc)>
 
-Get filename information as a c string
+Return the filename for C<ctx_pmc> as a C string.
 
 =cut