docs: updates from Homebrew/brew

Homebrew · Apr 26, 2024 · bf2b5a5 · bf2b5a5
1 parent 3081eeb
commit bf2b5a5
Show file tree

Hide file tree

Showing 829 changed files with 63,450 additions and 23,929 deletions.
diff --git a/docs/APIHashable.html b/docs/APIHashable.html
@@ -62,7 +62,7 @@
       <div id="content"><h1>Module: APIHashable
 
 
-
+  <span class="private note title">Private</span>
 </h1>
 <div class="box_info">
 
@@ -90,7 +90,12 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>Used to substitute common paths with generic placeholders when generating JSON for the API.</p>
+    <p class="note private">
+  <strong>This module is part of a private API.</strong>
+  This module may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
+  Third parties should avoid using this module if possible, as it may be removed or changed without warning.
+</p>
+<p>Used to substitute common paths with generic placeholders when generating JSON for the API.</p>
 
 
   </div>
@@ -127,7 +132,7 @@ <h2>
 
 
 
-
+  <span class="private note title">private</span>
 
     <span class="summary_desc"><div class='inline'>
 </div></span>
@@ -149,7 +154,7 @@ <h2>
 
 
 
-
+  <span class="private note title">private</span>
 
     <span class="summary_desc"><div class='inline'>
 </div></span>
@@ -171,7 +176,7 @@ <h2>
 
 
 
-
+  <span class="private note title">private</span>
 
     <span class="summary_desc"><div class='inline'>
 </div></span>
@@ -197,7 +202,22 @@ <h3 class="signature first" id="generated_hash!-instance_method">
 
 
 
-</h3><table class="source_code">
+</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">
@@ -241,7 +261,22 @@ <h3 class="signature " id="generating_hash!-instance_method">
 
 
 
-</h3><table class="source_code">
+</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">
@@ -293,7 +328,12 @@ <h3 class="signature " id="generating_hash?-instance_method">
 
 </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>

diff --git a/docs/AbstractCoreTap.html b/docs/AbstractCoreTap.html
diff --git a/docs/AbstractDownloadStrategy.html b/docs/AbstractDownloadStrategy.html
@@ -510,18 +510,18 @@ <h3 class="signature first" id="initialize-instance_method">
       <pre class="lines">
 
 
+56
+57
+58
+59
 60
 61
 62
 63
-64
-65
-66
-67
-68</pre>
+64</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 56</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_meta'>meta</span><span class='rparen'>)</span>
   <span class='ivar'>@url</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span>
@@ -574,12 +574,12 @@ <h3 class="signature first" id="cache-instance_method">
       <pre class="lines">
 
 
-56
-57
-58</pre>
+52
+53
+54</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 52</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_cache'>cache</span>
   <span class='ivar'>@cache</span>
@@ -629,12 +629,12 @@ <h3 class="signature " id="cached_location-instance_method">
       <pre class="lines">
 
 
-54
-55
-56</pre>
+50
+51
+52</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 54</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 50</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_cached_location'>cached_location</span>
   <span class='ivar'>@cached_location</span>
@@ -684,12 +684,12 @@ <h3 class="signature " id="source_modified_time-instance_method">
       <pre class="lines">
 
 
-138
-139
-140</pre>
+133
+134
+135</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 138</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 133</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_source_modified_time'>source_modified_time</span>
   <span class='const'><span class='object_link'><a href="Pathname.html" title="Pathname (class)">Pathname</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span><span class='period'>.</span><span class='id identifier rubyid_to_enum'>to_enum</span><span class='lparen'>(</span><span class='symbol'>:find</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:file?</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:mtime</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_max'>max</span>
@@ -739,12 +739,12 @@ <h3 class="signature " id="url-instance_method">
       <pre class="lines">
 
 
-48
-49
-50</pre>
+44
+45
+46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 48</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 44</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
   <span class='ivar'>@url</span>
@@ -791,12 +791,12 @@ <h3 class="signature first" id="basename-instance_method">
       <pre class="lines">
 
 
-150
-151
-152</pre>
+145
+146
+147</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 150</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 145</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_basename'>basename</span>
   <span class='id identifier rubyid_cached_location'>cached_location</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span>
@@ -832,12 +832,12 @@ <h3 class="signature " id="clear_cache-instance_method">
       <pre class="lines">
 
 
-146
-147
-148</pre>
+141
+142
+143</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 146</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 141</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_clear_cache'>clear_cache</span>
   <span class='id identifier rubyid_rm_rf'>rm_rf</span><span class='lparen'>(</span><span class='id identifier rubyid_cached_location'>cached_location</span><span class='rparen'>)</span>
@@ -872,10 +872,10 @@ <h3 class="signature " id="fetch-instance_method">
       <pre class="lines">
 
 
-73</pre>
+69</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 73</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 69</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
     </td>
@@ -908,12 +908,12 @@ <h3 class="signature " id="quiet!-instance_method">
       <pre class="lines">
 
 
-79
-80
-81</pre>
+75
+76
+77</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 79</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 75</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_quiet!'>quiet!</span>
   <span class='ivar'>@quiet</span> <span class='op'>=</span> <span class='kw'>true</span>
@@ -966,12 +966,12 @@ <h3 class="signature " id="quiet?-instance_method">
       <pre class="lines">
 
 
-93
-94
-95</pre>
+88
+89
+90</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 93</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 88</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_quiet?'>quiet?</span>
   <span class='const'><span class='object_link'><a href="Context.html" title="Context (module)">Context</a></span></span><span class='period'>.</span><span class='id identifier rubyid_current'><span class='object_link'><a href="Context.html#current-class_method" title="Context.current (method)">current</a></span></span><span class='period'>.</span><span class='id identifier rubyid_quiet?'>quiet?</span> <span class='op'>||</span> <span class='ivar'>@quiet</span>
@@ -1013,13 +1013,13 @@ <h3 class="signature " id="shutup!-instance_method">
       <pre class="lines">
 
 
-88
-89
-90
-91</pre>
+83
+84
+85
+86</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 88</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 83</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_shutup!'>shutup!</span>
   <span class='id identifier rubyid_odeprecated'>odeprecated</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>AbstractDownloadStrategy#shutup!</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'>AbstractDownloadStrategy#quiet!</span><span class='tstring_end'>&quot;</span></span>
@@ -1061,18 +1061,18 @@ <h3 class="signature " id="stage-instance_method">
       <pre class="lines">
 
 
+101
+102
+103
+104
+105
 106
 107
 108
-109
-110
-111
-112
-113
-114</pre>
+109</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 106</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 101</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_stage'>stage</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='const'><span class='object_link'><a href="UnpackStrategy.html" title="UnpackStrategy (module)">UnpackStrategy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_detect'><span class='object_link'><a href="UnpackStrategy.html#detect-class_method" title="UnpackStrategy.detect (method)">detect</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cached_location'>cached_location</span><span class='comma'>,</span>

diff --git a/docs/AbstractDownloadStrategy/Pourable.html b/docs/AbstractDownloadStrategy/Pourable.html
@@ -176,13 +176,13 @@ <h3 class="signature first" id="stage-instance_method">
       <pre class="lines">
 
 
-38
-39
-40
-41</pre>
+34
+35
+36
+37</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 38</span>
+      <pre class="code"><span class="info file"># File 'download_strategy.rb', line 34</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_stage'>stage</span>
   <span class='id identifier rubyid_ohai'>ohai</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Pouring </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_basename'>basename</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>