Skip to content

Commit

Permalink
build based on 2b2def3
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 3, 2023
1 parent f4e6201 commit 5d64820
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@

julia> timings_enabled() = rand() < 0.5;

julia&gt; @tracepoint &quot;pow5&quot; enabled=timings_enabled() x^5; # enabled only if timings_enabled() is true</code></pre><p>If you don&#39;t have Tracy installed, you can install <code>TracyProfiler_jll</code> and start it with <code>run(TracyProfiler_jll.tracy(); wait=false)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/8d07a3ebe960aa03732695e5674a11800c7e8916/src/tracepoint.jl#L35-L94">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.tracymsg" href="#Tracy.tracymsg"><code>Tracy.tracymsg</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tracymsg(msg::AbstractString; color::Union{Integer,Symbol,NTuple{3, Integer}, Nothing}=nothing, callstack_depth::Integer=0)</code></pre><p>Send a message to Tracy that gets shown in the &quot;Message&quot; window. If <code>color</code> is <code>nothing</code>, the default color is used. Otherwise, the <code>color</code> argument can be given as:</p><ul><li>An integer: The hex code of the color as <code>0xRRGGBB</code>.</li><li>A symbol: Can take the value <code>:black</code>, <code>:blue</code>, <code>:green</code>, <code>:cyan</code>, <code>:red</code>, <code>:magenta</code>, <code>:yellow</code>, <code>:white</code>, <code>:light_black</code>, <code>:light_blue</code>, <code>:light_green</code>, <code>:light_cyan</code>, <code>:light_red</code>, <code>:light_magenta</code>, <code>:light_yellow</code>, <code>:light_white</code>.</li><li>A tuple of three integers: The RGB value <code>(R, G, B)</code> where each value is in the range 0..255.</li></ul><p>The <code>callstack_depth</code> argument determines the depth of the callstack that is collected.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/8d07a3ebe960aa03732695e5674a11800c7e8916/src/msg.jl#L1-L10">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.@register_tracepoints" href="#Tracy.@register_tracepoints"><code>Tracy.@register_tracepoints</code></a> — <span class="docstring-category">Macro</span></header><section><div><p>Register this module&#39;s <code>@tracepoint</code> callsites with Tracy.jl</p><p>This will allow tracepoints to appear in Tracy&#39;s Enable/Disable window, even if they haven&#39;t been run yet. Using this macro is optional, but it&#39;s recommended to call it from within your module&#39;s <code>__init__</code> method.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/8d07a3ebe960aa03732695e5674a11800c7e8916/src/tracepoint.jl#L237-L243">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.enable_tracepoint" href="#Tracy.enable_tracepoint"><code>Tracy.enable_tracepoint</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">enable_tracepoint</code></pre><p>Enable/disable a set of tracepoint(s) in the provided modules, based on whether they match the filters provided for <code>name</code>/<code>func</code>/<code>file</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/8d07a3ebe960aa03732695e5674a11800c7e8916/src/tracepoint.jl#L221-L226">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.configure_tracepoint" href="#Tracy.configure_tracepoint"><code>Tracy.configure_tracepoint</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">configure_tracepoint</code></pre><p>Enable/disable a set of tracepoint(s) in the provided modules by invalidating any existing code containing the tracepoint(s).</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This invalidates the code generated for all functions containing the selected zones.</p><p>This will trigger re-compilation for these functions and may cause undesirable latency. It is strongly recommended to use <code>enable_tracepoint</code> instead.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/8d07a3ebe960aa03732695e5674a11800c7e8916/src/tracepoint.jl#L198-L209">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.wait_for_tracy" href="#Tracy.wait_for_tracy"><code>Tracy.wait_for_tracy</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">wait_for_tracy(;timeout::Float64 = 20.0)</code></pre><p>Waits up to <code>timeout</code> seconds for <code>libtracy</code> to connect to a listening capture agent. If a timeout occurs, throws an <code>InvalidStateException</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/8d07a3ebe960aa03732695e5674a11800c7e8916/src/utils.jl#L18-L23">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.capture" href="#Tracy.capture"><code>Tracy.capture</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">capture(outfile::String; port::Integer = 9001)
julia&gt; @tracepoint &quot;pow5&quot; enabled=timings_enabled() x^5; # enabled only if timings_enabled() is true</code></pre><p>If you don&#39;t have Tracy installed, you can install <code>TracyProfiler_jll</code> and start it with <code>run(TracyProfiler_jll.tracy(); wait=false)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/2b2def3e08ad5b06bad2e1360c25d217d27b9a21/src/tracepoint.jl#L35-L94">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.tracymsg" href="#Tracy.tracymsg"><code>Tracy.tracymsg</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tracymsg(msg::AbstractString; color::Union{Integer,Symbol,NTuple{3, Integer}, Nothing}=nothing, callstack_depth::Integer=0)</code></pre><p>Send a message to Tracy that gets shown in the &quot;Message&quot; window. If <code>color</code> is <code>nothing</code>, the default color is used. Otherwise, the <code>color</code> argument can be given as:</p><ul><li>An integer: The hex code of the color as <code>0xRRGGBB</code>.</li><li>A symbol: Can take the value <code>:black</code>, <code>:blue</code>, <code>:green</code>, <code>:cyan</code>, <code>:red</code>, <code>:magenta</code>, <code>:yellow</code>, <code>:white</code>, <code>:light_black</code>, <code>:light_blue</code>, <code>:light_green</code>, <code>:light_cyan</code>, <code>:light_red</code>, <code>:light_magenta</code>, <code>:light_yellow</code>, <code>:light_white</code>.</li><li>A tuple of three integers: The RGB value <code>(R, G, B)</code> where each value is in the range 0..255.</li></ul><p>The <code>callstack_depth</code> argument determines the depth of the callstack that is collected.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/2b2def3e08ad5b06bad2e1360c25d217d27b9a21/src/msg.jl#L1-L10">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.@register_tracepoints" href="#Tracy.@register_tracepoints"><code>Tracy.@register_tracepoints</code></a> — <span class="docstring-category">Macro</span></header><section><div><p>Register this module&#39;s <code>@tracepoint</code> callsites with Tracy.jl</p><p>This will allow tracepoints to appear in Tracy&#39;s Enable/Disable window, even if they haven&#39;t been run yet. Using this macro is optional, but it&#39;s recommended to call it from within your module&#39;s <code>__init__</code> method.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/2b2def3e08ad5b06bad2e1360c25d217d27b9a21/src/tracepoint.jl#L240-L246">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.enable_tracepoint" href="#Tracy.enable_tracepoint"><code>Tracy.enable_tracepoint</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">enable_tracepoint</code></pre><p>Enable/disable a set of tracepoint(s) in the provided modules, based on whether they match the filters provided for <code>name</code>/<code>func</code>/<code>file</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/2b2def3e08ad5b06bad2e1360c25d217d27b9a21/src/tracepoint.jl#L224-L229">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.configure_tracepoint" href="#Tracy.configure_tracepoint"><code>Tracy.configure_tracepoint</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">configure_tracepoint</code></pre><p>Enable/disable a set of tracepoint(s) in the provided modules by invalidating any existing code containing the tracepoint(s).</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This invalidates the code generated for all functions containing the selected zones.</p><p>This will trigger re-compilation for these functions and may cause undesirable latency. It is strongly recommended to use <code>enable_tracepoint</code> instead.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/2b2def3e08ad5b06bad2e1360c25d217d27b9a21/src/tracepoint.jl#L201-L212">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.wait_for_tracy" href="#Tracy.wait_for_tracy"><code>Tracy.wait_for_tracy</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">wait_for_tracy(;timeout::Float64 = 20.0)</code></pre><p>Waits up to <code>timeout</code> seconds for <code>libtracy</code> to connect to a listening capture agent. If a timeout occurs, throws an <code>InvalidStateException</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/2b2def3e08ad5b06bad2e1360c25d217d27b9a21/src/utils.jl#L18-L23">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Tracy.capture" href="#Tracy.capture"><code>Tracy.capture</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">capture(outfile::String; port::Integer = 9001)
gui(; port::Integer = 9001)</code></pre><p>Starts a Tracy capture agent running in the background. Returns the <code>Cmd</code> object for use with <code>wait()</code>. Note that if you are using a tracy-enabled build of Julia, you will need to ensure that the capture agent is running before the Julia executable starts, otherwise the capture agent may not see the beginning of every zone, which it considers to be a fatal error.</p><p>The recommended methodology for usage of this function is something similar to:</p><pre><code class="nohighlight hljs"> port = 9000 + rand(1:1000)
p = Tracy.capture(&quot;my_workload.tracy&quot;; port)
run(addenv(`$(Base.julia_cmd()) workload.jl`,
&quot;TRACY_PORT&quot; =&gt; string(port),
&quot;JULIA_WAIT_FOR_TRACY&quot; =&gt; &quot;1&quot;))
wait(p)</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This command is only available if you also load <code>TracyProfiler_jll</code>.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/8d07a3ebe960aa03732695e5674a11800c7e8916/src/utils.jl#L35-L58">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 25 July 2023 15:39">Tuesday 25 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
wait(p)</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This command is only available if you also load <code>TracyProfiler_jll</code>.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/topolarity/Tracy.jl/blob/2b2def3e08ad5b06bad2e1360c25d217d27b9a21/src/utils.jl#L35-L58">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 3 October 2023 17:00">Tuesday 3 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 5d64820

Please sign in to comment.