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 Jan 12, 2024
1 parent 420586a commit 35ef605
Show file tree
Hide file tree
Showing 2 changed files with 3,875 additions and 3,788 deletions.
263 changes: 171 additions & 92 deletions docs/Homebrew/FormulaAuditor.html
Original file line number Diff line number Diff line change
Expand Up @@ -857,7 +857,7 @@ <h2>
<li class="public ">
<span class="summary_signature">

<a href="#audit_revision_and_version_scheme-instance_method" title="#audit_revision_and_version_scheme (instance method)">#<strong>audit_revision_and_version_scheme</strong> &#x21d2; Object </a>
<a href="#audit_revision-instance_method" title="#audit_revision (instance method)">#<strong>audit_revision</strong> &#x21d2; Object </a>


</span>
Expand Down Expand Up @@ -999,6 +999,28 @@ <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="#audit_version_scheme-instance_method" title="#audit_version_scheme (instance method)">#<strong>audit_version_scheme</strong> &#x21d2; Object </a>


</span>






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

<span class="summary_desc"><div class='inline'>
Expand Down Expand Up @@ -1520,21 +1542,21 @@ <h3 class="signature first" id="audit-instance_method">
<pre class="lines">


914
915
916
917
918
919
920
921
922
923
924
925</pre>
925
926
927
928
929
930
931
932
933
934
935</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 914</span>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 924</span>

<span class='kw'>def</span> <span class='id identifier rubyid_audit'>audit</span>
<span class='id identifier rubyid_only_audits'>only_audits</span> <span class='op'>=</span> <span class='ivar'>@only</span>
Expand Down Expand Up @@ -3297,19 +3319,19 @@ <h3 class="signature " id="audit_prefix_has_contents-instance_method">
<pre class="lines">


895
896
897
898
899
900
901
902
903
904</pre>
905
906
907
908
909
910
911
912
913
914</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 895</span>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 905</span>

<span class='kw'>def</span> <span class='id identifier rubyid_audit_prefix_has_contents'>audit_prefix_has_contents</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_prefix'>prefix</span><span class='period'>.</span><span class='id identifier rubyid_directory?'>directory?</span>
Expand Down Expand Up @@ -3356,21 +3378,21 @@ <h3 class="signature " id="audit_reverse_migration-instance_method">
<pre class="lines">


882
883
884
885
886
887
888
889
890
891
892
893</pre>
893
894
895
896
897
898
899
900
901
902
903</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 882</span>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 892</span>

<span class='kw'>def</span> <span class='id identifier rubyid_audit_reverse_migration'>audit_reverse_migration</span>
<span class='comment'># Only enforce for new formula being re-added to core
Expand All @@ -3390,9 +3412,9 @@ <h3 class="signature " id="audit_reverse_migration-instance_method">
</div>

<div class="method_details ">
<h3 class="signature " id="audit_revision_and_version_scheme-instance_method">
<h3 class="signature " id="audit_revision-instance_method">

#<strong>audit_revision_and_version_scheme</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
#<strong>audit_revision</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>



Expand Down Expand Up @@ -3446,22 +3468,12 @@ <h3 class="signature " id="audit_revision_and_version_scheme-instance_method">
824
825
826
827
828
829
830
831
832
833
834
835
836
837</pre>
827</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 800</span>

<span class='kw'>def</span> <span class='id identifier rubyid_audit_revision_and_version_scheme'>audit_revision_and_version_scheme</span>
<span class='kw'>def</span> <span class='id identifier rubyid_audit_revision'>audit_revision</span>
<span class='id identifier rubyid_new_formula_problem'>new_formula_problem</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>New formulae should not define a revision.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@new_formula</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_revision'>revision</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span>

<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@git</span>
Expand All @@ -3470,20 +3482,10 @@ <h3 class="signature " id="audit_revision_and_version_scheme-instance_method">
</span> <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_stable'>stable</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>

<span class='id identifier rubyid_current_version'>current_version</span> <span class='op'>=</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_stable'>stable</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
<span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span> <span class='op'>=</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_version_scheme'>version_scheme</span>
<span class='id identifier rubyid_current_revision'>current_revision</span> <span class='op'>=</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_revision'>revision</span>

<span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='comma'>,</span> <span class='id identifier rubyid_newest_committed'>newest_committed</span> <span class='op'>=</span> <span class='id identifier rubyid_committed_version_info'>committed_version_info</span>

<span class='kw'>unless</span> <span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>if</span> <span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_problem'>problem</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>version_scheme should not decrease (from </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> \
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>to </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span> <span class='op'>&gt;</span> <span class='lparen'>(</span><span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='int'>1</span><span class='rparen'>)</span>
<span class='id identifier rubyid_problem'>problem</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>version_schemes should only increment by 1</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>

<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version</span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='id identifier rubyid_newest_committed'>newest_committed</span><span class='lbracket'>[</span><span class='symbol'>:version</span><span class='rbracket'>]</span> <span class='op'>||</span>
<span class='id identifier rubyid_current_version'>current_version</span> <span class='op'>!=</span> <span class='id identifier rubyid_newest_committed'>newest_committed</span><span class='lbracket'>[</span><span class='symbol'>:version</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
<span class='op'>!</span><span class='id identifier rubyid_current_revision'>current_revision</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span> <span class='op'>&amp;&amp;</span>
Expand Down Expand Up @@ -4030,27 +4032,27 @@ <h3 class="signature " id="audit_text-instance_method">
<pre class="lines">


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880</pre>
880
881
882
883
884
885
886
887
888
889
890</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 863</span>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 873</span>

<span class='kw'>def</span> <span class='id identifier rubyid_audit_text'>audit_text</span>
<span class='id identifier rubyid_bin_names'>bin_names</span> <span class='op'>=</span> <span class='const'>Set</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
Expand Down Expand Up @@ -4105,16 +4107,6 @@ <h3 class="signature " id="audit_unconfirmed_checksum_change-instance_method">
<pre class="lines">


839
840
841
842
843
844
845
846
847
848
849
850
851
Expand All @@ -4127,10 +4119,20 @@ <h3 class="signature " id="audit_unconfirmed_checksum_change-instance_method">
858
859
860
861</pre>
861
862
863
864
865
866
867
868
869
870
871</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 839</span>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 849</span>

<span class='kw'>def</span> <span class='id identifier rubyid_audit_unconfirmed_checksum_change'>audit_unconfirmed_checksum_change</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@git</span>
Expand Down Expand Up @@ -4158,6 +4160,83 @@ <h3 class="signature " id="audit_unconfirmed_checksum_change-instance_method">
</td>
</tr>
</table>
</div>

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

#<strong>audit_version_scheme</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></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">


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


829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 829</span>

<span class='kw'>def</span> <span class='id identifier rubyid_audit_version_scheme'>audit_version_scheme</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@git</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='comment'># skip formula not from core or any taps
</span> <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_git?'>git?</span> <span class='comment'># git log is required
</span> <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_stable'>stable</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>

<span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span> <span class='op'>=</span> <span class='id identifier rubyid_formula'>formula</span><span class='period'>.</span><span class='id identifier rubyid_version_scheme'>version_scheme</span>

<span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='comma'>,</span> <span class='op'>=</span> <span class='id identifier rubyid_committed_version_info'>committed_version_info</span>

<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>

<span class='kw'>if</span> <span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_problem'>problem</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>version_scheme should not decrease (from </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> \
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>to </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_current_version_scheme'>current_version_scheme</span> <span class='op'>&gt;</span> <span class='lparen'>(</span><span class='id identifier rubyid_previous_committed'>previous_committed</span><span class='lbracket'>[</span><span class='symbol'>:version_scheme</span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='int'>1</span><span class='rparen'>)</span>
<span class='id identifier rubyid_problem'>problem</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>version_schemes should only increment by 1</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
Expand Down Expand Up @@ -4320,12 +4399,12 @@ <h3 class="signature " id="problem_if_output-instance_method">
<pre class="lines">


910
911
912</pre>
920
921
922</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 910</span>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 920</span>

<span class='kw'>def</span> <span class='id identifier rubyid_problem_if_output'>problem_if_output</span><span class='lparen'>(</span><span class='id identifier rubyid_output'>output</span><span class='rparen'>)</span>
<span class='id identifier rubyid_problem'>problem</span><span class='lparen'>(</span><span class='id identifier rubyid_output'>output</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_output'>output</span>
Expand Down Expand Up @@ -4365,12 +4444,12 @@ <h3 class="signature " id="quote_dep-instance_method">
<pre class="lines">


906
907
908</pre>
916
917
918</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 906</span>
<pre class="code"><span class="info file"># File 'formula_auditor.rb', line 916</span>

<span class='kw'>def</span> <span class='id identifier rubyid_quote_dep'>quote_dep</span><span class='lparen'>(</span><span class='id identifier rubyid_dep'>dep</span><span class='rparen'>)</span>
<span class='id identifier rubyid_dep'>dep</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_dep'>dep</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_dep'>dep</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39;</span><span class='tstring_end'>&quot;</span></span>
Expand Down
Loading

0 comments on commit 35ef605

Please sign in to comment.