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 Dec 6, 2023
1 parent e38f1c3 commit f0506c8
Show file tree
Hide file tree
Showing 8 changed files with 151 additions and 121 deletions.
116 changes: 72 additions & 44 deletions docs/Homebrew.html
Original file line number Diff line number Diff line change
Expand Up @@ -10535,18 +10535,6 @@ <h3 class="signature " id="audit-class_method">
<pre class="lines">


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
Expand Down Expand Up @@ -10765,22 +10753,38 @@ <h3 class="signature " id="audit-class_method">
328
329
330
331</pre>
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'dev-cmd/audit.rb', line 101</span>
<pre class="code"><span class="info file"># File 'dev-cmd/audit.rb', line 113</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_audit'>audit</span>
<span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='id identifier rubyid_audit_args'>audit_args</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span>

<span class='id identifier rubyid_new_cask'>new_cask</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_new?'>new?</span> <span class='op'>||</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_new_cask?'>new_cask?</span>
<span class='id identifier rubyid_new_formula'>new_formula</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_new?'>new?</span> <span class='op'>||</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_new_formula?'>new_formula?</span>

<span class='const'><span class='object_link'><a href="Formulary.html" title="Formulary (module)">Formulary</a></span></span><span class='period'>.</span><span class='id identifier rubyid_enable_factory_cache!'><span class='object_link'><a href="Formulary.html#enable_factory_cache!-class_method" title="Formulary.enable_factory_cache! (method)">enable_factory_cache!</a></span></span>

<span class='id identifier rubyid_os_arch_combinations'>os_arch_combinations</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_os_arch_combinations'>os_arch_combinations</span>

<span class='const'><span class='object_link'><a href="" title="Homebrew (module)">Homebrew</a></span></span><span class='period'>.</span><span class='id identifier rubyid_auditing'>auditing</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_inject_dump_stats!'>inject_dump_stats!</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Homebrew/FormulaAuditor.html" title="Homebrew::FormulaAuditor (class)">FormulaAuditor</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^audit_</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_audit_debug?'>audit_debug?</span>

<span class='id identifier rubyid_new_formula'>new_formula</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_new_formula?'>new_formula?</span>
<span class='id identifier rubyid_strict'>strict</span> <span class='op'>=</span> <span class='id identifier rubyid_new_formula'>new_formula</span> <span class='op'>||</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_strict?'>strict?</span>
<span class='id identifier rubyid_online'>online</span> <span class='op'>=</span> <span class='id identifier rubyid_new_formula'>new_formula</span> <span class='op'>||</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_online?'>online?</span>
<span class='id identifier rubyid_tap_audit'>tap_audit</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
Expand Down Expand Up @@ -10837,7 +10841,7 @@ <h3 class="signature " id="audit-class_method">

<span class='kw'>if</span> <span class='id identifier rubyid_only_cops'>only_cops</span>
<span class='id identifier rubyid_style_options'>style_options</span><span class='lbracket'>[</span><span class='symbol'>:only_cops</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_only_cops'>only_cops</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_new_formula?'>new_formula?</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_new_formula'>new_formula</span> <span class='op'>||</span> <span class='id identifier rubyid_new_cask'>new_cask</span>
<span class='kw'>nil</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_except_cops'>except_cops</span>
<span class='id identifier rubyid_style_options'>style_options</span><span class='lbracket'>[</span><span class='symbol'>:except_cops</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_except_cops'>except_cops</span>
Expand Down Expand Up @@ -10933,7 +10937,7 @@ <h3 class="signature " id="audit-class_method">
<span class='comment'># No need for `|| nil` for `--[no-]signing`
</span> <span class='comment'># because boolean switches are already `nil` if not passed
</span> <span class='label'>audit_signing:</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_signing?'>signing?</span><span class='comma'>,</span>
<span class='label'>audit_new_cask:</span> <span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_new_cask?'>new_cask?</span> <span class='op'>||</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='label'>audit_new_cask:</span> <span class='lparen'>(</span><span class='id identifier rubyid_new_cask'>new_cask</span> <span class='op'>||</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='label'>audit_token_conflicts:</span> <span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_token_conflicts?'>token_conflicts?</span> <span class='op'>||</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='label'>quarantine:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>any_named_args:</span> <span class='op'>!</span><span class='id identifier rubyid_no_named_args'>no_named_args</span><span class='comma'>,</span>
Expand Down Expand Up @@ -11118,7 +11122,19 @@ <h3 class="signature " id="audit_args-class_method">
95
96
97
98</pre>
98
99
100
101
102
103
104
105
106
107
108
109
110</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'dev-cmd/audit.rb', line 24</span>
Expand Down Expand Up @@ -11146,10 +11162,22 @@ <h3 class="signature " id="audit_args-class_method">
<span class='id identifier rubyid_switch'>switch</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--eval-all</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Evaluate all available formulae and casks, whether installed or not, to audit them. </span><span class='tstring_end'>&quot;</span></span> \
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Implied if `HOMEBREW_EVAL_ALL` is set.</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_switch'>switch</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--new</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'>--new-formula</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'>--new-cask</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='id identifier rubyid_switch'>switch</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--new</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Run various additional style checks to determine if a new formula or cask is eligible </span><span class='tstring_end'>&quot;</span></span> \
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>for Homebrew. This should be used when creating new formula and implies </span><span class='tstring_end'>&quot;</span></span> \
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>for Homebrew. This should be used when creating new formulae or casks and implies </span><span class='tstring_end'>&quot;</span></span> \
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>`--strict` and `--online`.</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_switch'>switch</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--new-formula</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='comment'># odeprecated: uncomment `replacement` to enable the `odeprecated` handling in `CLI::Parser`
</span> <span class='comment'># replacement: &quot;--new&quot;,
</span> <span class='comment'># odeprecated: remove `args.new_formula?` calls once this is `true`
</span> <span class='label'>disable:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>hidden:</span> <span class='kw'>true</span>
<span class='id identifier rubyid_switch'>switch</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--new-cask</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='comment'># odeprecated: uncomment `replacement` to enable the `odeprecated` handling in `CLI::Parser`
</span> <span class='comment'># replacement: &quot;--new&quot;,
</span> <span class='comment'># odeprecated: remove `args.new_cask?` calls once this is `true`
</span> <span class='label'>disable:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>hidden:</span> <span class='kw'>true</span>
<span class='id identifier rubyid_switch'>switch</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--[no-]signing</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Audit for signed apps, which are required on ARM</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_switch'>switch</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--token-conflicts</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
Expand Down Expand Up @@ -21393,18 +21421,18 @@ <h3 class="signature " id="format_problem_lines-class_method">
<pre class="lines">


347
348
349
350
351
352
353
354
355</pre>
361
362
363
364
365
366
367
368
369</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'dev-cmd/audit.rb', line 347</span>
<pre class="code"><span class="info file"># File 'dev-cmd/audit.rb', line 361</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_format_problem_lines'>format_problem_lines</span><span class='lparen'>(</span><span class='id identifier rubyid_problems'>problems</span><span class='rparen'>)</span>
<span class='id identifier rubyid_problems'>problems</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_problem'>problem</span><span class='op'>|</span>
Expand Down Expand Up @@ -34317,22 +34345,22 @@ <h3 class="signature " id="print_problems-class_method">
<pre class="lines">


333
334
335
336
337
338
339
340
341
342
343
344
345</pre>
347
348
349
350
351
352
353
354
355
356
357
358
359</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'dev-cmd/audit.rb', line 333</span>
<pre class="code"><span class="info file"># File 'dev-cmd/audit.rb', line 347</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_print_problems'>print_problems</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='comma'>,</span> <span class='label'>display_filename:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_problems'>problems</span><span class='op'>|</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/Homebrew/CLI/InvalidConstraintError.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,12 +190,12 @@ <h3 class="signature first" id="initialize-instance_method">
<pre class="lines">


687
688
689</pre>
689
690</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 687</span>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 688</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_arg1'>arg1</span><span class='comma'>,</span> <span class='id identifier rubyid_arg2'>arg2</span><span class='rparen'>)</span>
<span class='kw'>super</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>`</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_arg1'>arg1</span><span class='embexpr_end'>}</span><span class='tstring_content'>` and `</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_arg2'>arg2</span><span class='embexpr_end'>}</span><span class='tstring_content'>` cannot be mutually exclusive and mutually dependent simultaneously.</span><span class='tstring_end'>&quot;</span></span>
Expand Down
6 changes: 3 additions & 3 deletions docs/Homebrew/CLI/MaxNamedArgumentsError.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,6 @@ <h3 class="signature first" id="initialize-instance_method">
<pre class="lines">


694
695
696
697
Expand All @@ -229,10 +228,11 @@ <h3 class="signature first" id="initialize-instance_method">
702
703
704
705</pre>
705
706</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 694</span>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 695</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_maximum'>maximum</span><span class='comma'>,</span> <span class='label'>types:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>super</span> <span class='kw'>case</span> <span class='id identifier rubyid_maximum'>maximum</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/Homebrew/CLI/MinNamedArgumentsError.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,16 +218,16 @@ <h3 class="signature first" id="initialize-instance_method">
<pre class="lines">


710
711
712
713
714
715
716</pre>
716
717</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 710</span>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 711</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_minimum'>minimum</span><span class='comma'>,</span> <span class='label'>types:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_types'>types</span> <span class='op'>&lt;&lt;</span> <span class='symbol'>:named</span> <span class='kw'>if</span> <span class='id identifier rubyid_types'>types</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/Homebrew/CLI/NumberOfNamedArgumentsError.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,16 +218,16 @@ <h3 class="signature first" id="initialize-instance_method">
<pre class="lines">


721
722
723
724
725
726
727</pre>
727
728</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 721</span>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 722</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_minimum'>minimum</span><span class='comma'>,</span> <span class='label'>types:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_types'>types</span> <span class='op'>&lt;&lt;</span> <span class='symbol'>:named</span> <span class='kw'>if</span> <span class='id identifier rubyid_types'>types</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/Homebrew/CLI/OptionConflictError.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,14 +190,14 @@ <h3 class="signature first" id="initialize-instance_method">
<pre class="lines">


679
680
681
682
683</pre>
683
684</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 679</span>
<pre class="code"><span class="info file"># File 'cli/parser.rb', line 680</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_args_list'>args_list</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</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_public_method'>public_method</span><span class='lparen'>(</span><span class='symbol'>:option</span><span class='rparen'>)</span><span class='rparen'>)</span>
Expand Down
Loading

0 comments on commit f0506c8

Please sign in to comment.