-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clean up stdlib/profile, backport of 0b5811d
- Loading branch information
1 parent
0a73933
commit 75df2f1
Showing
1 changed file
with
4 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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`. | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
staticfloat
Author
Member
|
||
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. |
not sure whether it was intended to leave the dot in here? (same below for
.clear
)