Skip to content

Commit

Permalink
docs: updates from Homebrew/brew
Browse files Browse the repository at this point in the history
  • Loading branch information
BrewTestBot committed May 20, 2024
1 parent 27d33a5 commit e7082e6
Show file tree
Hide file tree
Showing 3 changed files with 255 additions and 155 deletions.
32 changes: 25 additions & 7 deletions docs/Homebrew/DevCmd/Prof.html
Original file line number Diff line number Diff line change
Expand Up @@ -293,8 +293,6 @@ <h3 class="signature " id="run-instance_method">
<pre class="lines">


20
21
22
23
24
Expand Down Expand Up @@ -333,10 +331,21 @@ <h3 class="signature " id="run-instance_method">
57
58
59
60</pre>
60
61
62
63
64
65
66
67
68
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'dev-cmd/prof.rb', line 20</span>
<pre class="code"><span class="info file"># File 'dev-cmd/prof.rb', line 22</span>

<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span>
<span class='const'><span class='object_link'><a href="../../Homebrew.html" title="Homebrew (module)">Homebrew</a></span></span><span class='period'>.</span><span class='id identifier rubyid_install_bundler_gems!'><span class='object_link'><a href="../../Homebrew.html#install_bundler_gems!-class_method" title="Homebrew.install_bundler_gems! (method)">install_bundler_gems!</a></span></span><span class='lparen'>(</span><span class='label'>groups:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>prof</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>setup_path:</span> <span class='kw'>false</span><span class='rparen'>)</span>
Expand All @@ -360,17 +369,26 @@ <h3 class="signature " id="run-instance_method">
<span class='const'><span class='object_link'><a href="../../Homebrew.html" title="Homebrew (module)">Homebrew</a></span></span><span class='period'>.</span><span class='id identifier rubyid_setup_gem_environment!'><span class='object_link'><a href="../../Homebrew.html#setup_gem_environment!-class_method" title="Homebrew.setup_gem_environment! (method)">setup_gem_environment!</a></span></span>

<span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_stackprof?'>stackprof?</span>
<span class='id identifier rubyid_with_env'>with_env</span> <span class='label'>HOMEBREW_STACKPROF:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='comment'># odeprecated. vernier is better in every way
</span> <span class='id identifier rubyid_with_env'>with_env</span> <span class='label'>HOMEBREW_STACKPROF:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='op'>*</span><span class='const'><span class='object_link'><a href="../../top-level-namespace.html#HOMEBREW_RUBY_EXEC_ARGS-constant" title="HOMEBREW_RUBY_EXEC_ARGS (constant)">HOMEBREW_RUBY_EXEC_ARGS</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_brew_rb'>brew_rb</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_named'>named</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_output_filename'>output_filename</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>prof/d3-flamegraph.html</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_safe_system'>safe_system</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>stackprof --d3-flamegraph prof/stackprof.dump &gt; </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_output_filename'>output_filename</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_exec_browser'>exec_browser</span> <span class='id identifier rubyid_output_filename'>output_filename</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_vernier?'>vernier?</span>
<span class='id identifier rubyid_output_filename'>output_filename</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>prof/vernier.json</span><span class='tstring_end'>&quot;</span></span>
<span class='const'>Process</span><span class='op'>::</span><span class='const'>UID</span><span class='period'>.</span><span class='id identifier rubyid_change_privilege'>change_privilege</span><span class='lparen'>(</span><span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_euid'>euid</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_euid'>euid</span> <span class='op'>!=</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_uid'>uid</span>
<span class='id identifier rubyid_safe_system'>safe_system</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>vernier</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>run</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--output=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_output_filename'>output_filename</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--allocation_sample_rate=500</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="../../top-level-namespace.html#RUBY_PATH-constant" title="RUBY_PATH (constant)">RUBY_PATH</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_brew_rb'>brew_rb</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_named'>named</span>
<span class='id identifier rubyid_ohai'>ohai</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Profiling complete!</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Upload the results from </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_output_filename'>output_filename</span><span class='embexpr_end'>}</span><span class='tstring_content'> to:</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../../Formatter.html" title="Formatter (module)">Formatter</a></span></span><span class='period'>.</span><span class='id identifier rubyid_url'><span class='object_link'><a href="../../Formatter.html#url-class_method" title="Formatter.url (method)">url</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://vernier.prof</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_output_filename'>output_filename</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>prof/call_stack.html</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_safe_system'>safe_system</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby-prof</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--printer=call_stack</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--file=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_output_filename'>output_filename</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_brew_rb'>brew_rb</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_named'>named</span>
<span class='id identifier rubyid_exec_browser'>exec_browser</span> <span class='id identifier rubyid_output_filename'>output_filename</span>
<span class='kw'>end</span>

<span class='id identifier rubyid_exec_browser'>exec_browser</span> <span class='id identifier rubyid_output_filename'>output_filename</span>
<span class='kw'>rescue</span> <span class='const'>OptionParser</span><span class='op'>::</span><span class='const'>InvalidOption</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid_ofail'>ofail</span> <span class='id identifier rubyid_e'>e</span>

Expand Down
74 changes: 74 additions & 0 deletions docs/Homebrew/DevCmd/Prof/Args.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,27 @@ <h2>



<span class="private note title">private</span>

<span class="summary_desc"><div class='inline'></div></span>

</li>



<li class="public ">
<span class="summary_signature">

<a href="#vernier%3F-instance_method" title="#vernier? (instance method)">#<strong>vernier?</strong> &#x21d2; Boolean </a>


</span>






<span class="private note title">private</span>

<span class="summary_desc"><div class='inline'></div></span>
Expand Down Expand Up @@ -246,6 +267,59 @@ <h3 class="signature first" id="stackprof?-instance_method">
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="vernier?-instance_method">

#<strong>vernier?</strong> &#x21d2; <tt>Boolean</tt>





</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
This method may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
Third parties should avoid using this method if possible, as it may be removed or changed without warning.
</p>


</div>
</div>
<div class="tags">

<p class="tag_title">Returns:</p>
<ul class="return">

<li>


<span class='type'>(<tt>Boolean</tt>)</span>



</li>

</ul>

</div><table class="source_code">
<tr>
<td>
<pre class="lines">


18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'sorbet/rbi/dsl/homebrew/dev_cmd/prof.rbi', line 18</span>

<span class='kw'>def</span> <span class='id identifier rubyid_vernier?'>vernier?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

</div>
Expand Down
Loading

0 comments on commit e7082e6

Please sign in to comment.