From 75df2f10d76d79ca29d04987f38b328baa476a4e Mon Sep 17 00:00:00 2001 From: Elliot Saba Date: Tue, 6 Jan 2015 13:12:39 -0800 Subject: [PATCH] Clean up stdlib/profile, backport of 0b5811d632a66751dfbce77865451ffd06c5d774 --- doc/stdlib/profile.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/stdlib/profile.rst b/doc/stdlib/profile.rst index 127ef56e7e0db..c8cc50c6baa0a 100644 --- a/doc/stdlib/profile.rst +++ b/doc/stdlib/profile.rst @@ -32,7 +32,7 @@ Profiling .. function:: print([io::IO = STDOUT,] data::Vector, lidict::Dict; format = :tree, combine = true, cols = tty_cols()) Prints profiling results to ``io``. This variant is used to examine - results exported by a previous call to ``Profile.retrieve()``. + results exported by a previous call to :func:`.retrieve`. Supply the vector ``data`` of backtraces and a dictionary ``lidict`` of line information. @@ -49,12 +49,12 @@ Profiling .. function:: fetch() -> data Returns a reference to the internal buffer of backtraces. Note that - subsequent operations, like ``Profile.clear()``, can affect + subsequent operations, like :func:`.clear`, can affect ``data`` unless you first make a copy. Note that the values in ``data`` have meaning only on this machine in the current session, because it depends on the exact memory addresses used in JIT-compiling. This function is primarily for internal use; - ``Profile.retrieve()`` may be a better choice for most users. + :func:`retrieve` may be a better choice for most users. .. function:: retrieve() -> data, lidict @@ -69,6 +69,6 @@ Profiling Clears any stored memory allocation data when running julia with ``--track-allocation``. Execute the command(s) you want to test - (to force JIT-compilation), then call ``clear_malloc_data()``. + (to force JIT-compilation), then call :func:`clear_malloc_data`. Then execute your command(s) again, quit julia, and examine the resulting ``*.mem`` files. \ No newline at end of file