Skip to content

Commit bf2b5a5

Browse files
committed
docs: updates from Homebrew/brew
1 parent 3081eeb commit bf2b5a5

File tree

829 files changed

+63450
-23929
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

829 files changed

+63450
-23929
lines changed

docs/APIHashable.html

+48-8
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<div id="content"><h1>Module: APIHashable
6363

6464

65-
65+
<span class="private note title">Private</span>
6666
</h1>
6767
<div class="box_info">
6868

@@ -90,7 +90,12 @@
9090

9191
<h2>Overview</h2><div class="docstring">
9292
<div class="discussion">
93-
<p>Used to substitute common paths with generic placeholders when generating JSON for the API.</p>
93+
<p class="note private">
94+
<strong>This module is part of a private API.</strong>
95+
This module may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
96+
Third parties should avoid using this module if possible, as it may be removed or changed without warning.
97+
</p>
98+
<p>Used to substitute common paths with generic placeholders when generating JSON for the API.</p>
9499

95100

96101
</div>
@@ -127,7 +132,7 @@ <h2>
127132

128133

129134

130-
135+
<span class="private note title">private</span>
131136

132137
<span class="summary_desc"><div class='inline'>
133138
</div></span>
@@ -149,7 +154,7 @@ <h2>
149154

150155

151156

152-
157+
<span class="private note title">private</span>
153158

154159
<span class="summary_desc"><div class='inline'>
155160
</div></span>
@@ -171,7 +176,7 @@ <h2>
171176

172177

173178

174-
179+
<span class="private note title">private</span>
175180

176181
<span class="summary_desc"><div class='inline'>
177182
</div></span>
@@ -197,7 +202,22 @@ <h3 class="signature first" id="generated_hash!-instance_method">
197202

198203

199204

200-
</h3><table class="source_code">
205+
</h3><div class="docstring">
206+
<div class="discussion">
207+
<p class="note private">
208+
<strong>This method is part of a private API.</strong>
209+
This method may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
210+
Third parties should avoid using this method if possible, as it may be removed or changed without warning.
211+
</p>
212+
213+
214+
215+
</div>
216+
</div>
217+
<div class="tags">
218+
219+
220+
</div><table class="source_code">
201221
<tr>
202222
<td>
203223
<pre class="lines">
@@ -241,7 +261,22 @@ <h3 class="signature " id="generating_hash!-instance_method">
241261

242262

243263

244-
</h3><table class="source_code">
264+
</h3><div class="docstring">
265+
<div class="discussion">
266+
<p class="note private">
267+
<strong>This method is part of a private API.</strong>
268+
This method may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
269+
Third parties should avoid using this method if possible, as it may be removed or changed without warning.
270+
</p>
271+
272+
273+
274+
</div>
275+
</div>
276+
<div class="tags">
277+
278+
279+
</div><table class="source_code">
245280
<tr>
246281
<td>
247282
<pre class="lines">
@@ -293,7 +328,12 @@ <h3 class="signature " id="generating_hash?-instance_method">
293328

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

298338

299339
</div>

docs/AbstractCoreTap.html

+216-21
Large diffs are not rendered by default.

docs/AbstractDownloadStrategy.html

+52-52
Original file line numberDiff line numberDiff line change
@@ -510,18 +510,18 @@ <h3 class="signature first" id="initialize-instance_method">
510510
<pre class="lines">
511511

512512

513+
56
514+
57
515+
58
516+
59
513517
60
514518
61
515519
62
516520
63
517-
64
518-
65
519-
66
520-
67
521-
68</pre>
521+
64</pre>
522522
</td>
523523
<td>
524-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 60</span>
524+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 56</span>
525525

526526
<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>
527527
<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">
574574
<pre class="lines">
575575

576576

577-
56
578-
57
579-
58</pre>
577+
52
578+
53
579+
54</pre>
580580
</td>
581581
<td>
582-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 56</span>
582+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 52</span>
583583

584584
<span class='kw'>def</span> <span class='id identifier rubyid_cache'>cache</span>
585585
<span class='ivar'>@cache</span>
@@ -629,12 +629,12 @@ <h3 class="signature " id="cached_location-instance_method">
629629
<pre class="lines">
630630

631631

632-
54
633-
55
634-
56</pre>
632+
50
633+
51
634+
52</pre>
635635
</td>
636636
<td>
637-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 54</span>
637+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 50</span>
638638

639639
<span class='kw'>def</span> <span class='id identifier rubyid_cached_location'>cached_location</span>
640640
<span class='ivar'>@cached_location</span>
@@ -684,12 +684,12 @@ <h3 class="signature " id="source_modified_time-instance_method">
684684
<pre class="lines">
685685

686686

687-
138
688-
139
689-
140</pre>
687+
133
688+
134
689+
135</pre>
690690
</td>
691691
<td>
692-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 138</span>
692+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 133</span>
693693

694694
<span class='kw'>def</span> <span class='id identifier rubyid_source_modified_time'>source_modified_time</span>
695695
<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">
739739
<pre class="lines">
740740

741741

742-
48
743-
49
744-
50</pre>
742+
44
743+
45
744+
46</pre>
745745
</td>
746746
<td>
747-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 48</span>
747+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 44</span>
748748

749749
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
750750
<span class='ivar'>@url</span>
@@ -791,12 +791,12 @@ <h3 class="signature first" id="basename-instance_method">
791791
<pre class="lines">
792792

793793

794-
150
795-
151
796-
152</pre>
794+
145
795+
146
796+
147</pre>
797797
</td>
798798
<td>
799-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 150</span>
799+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 145</span>
800800

801801
<span class='kw'>def</span> <span class='id identifier rubyid_basename'>basename</span>
802802
<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">
832832
<pre class="lines">
833833

834834

835-
146
836-
147
837-
148</pre>
835+
141
836+
142
837+
143</pre>
838838
</td>
839839
<td>
840-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 146</span>
840+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 141</span>
841841

842842
<span class='kw'>def</span> <span class='id identifier rubyid_clear_cache'>clear_cache</span>
843843
<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">
872872
<pre class="lines">
873873

874874

875-
73</pre>
875+
69</pre>
876876
</td>
877877
<td>
878-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 73</span>
878+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 69</span>
879879

880880
<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>
881881
</td>
@@ -908,12 +908,12 @@ <h3 class="signature " id="quiet!-instance_method">
908908
<pre class="lines">
909909

910910

911-
79
912-
80
913-
81</pre>
911+
75
912+
76
913+
77</pre>
914914
</td>
915915
<td>
916-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 79</span>
916+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 75</span>
917917

918918
<span class='kw'>def</span> <span class='id identifier rubyid_quiet!'>quiet!</span>
919919
<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">
966966
<pre class="lines">
967967

968968

969-
93
970-
94
971-
95</pre>
969+
88
970+
89
971+
90</pre>
972972
</td>
973973
<td>
974-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 93</span>
974+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 88</span>
975975

976976
<span class='kw'>def</span> <span class='id identifier rubyid_quiet?'>quiet?</span>
977977
<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">
10131013
<pre class="lines">
10141014

10151015

1016-
88
1017-
89
1018-
90
1019-
91</pre>
1016+
83
1017+
84
1018+
85
1019+
86</pre>
10201020
</td>
10211021
<td>
1022-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 88</span>
1022+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 83</span>
10231023

10241024
<span class='kw'>def</span> <span class='id identifier rubyid_shutup!'>shutup!</span>
10251025
<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">
10611061
<pre class="lines">
10621062

10631063

1064+
101
1065+
102
1066+
103
1067+
104
1068+
105
10641069
106
10651070
107
10661071
108
1067-
109
1068-
110
1069-
111
1070-
112
1071-
113
1072-
114</pre>
1072+
109</pre>
10731073
</td>
10741074
<td>
1075-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 106</span>
1075+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 101</span>
10761076

10771077
<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>
10781078
<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>

docs/AbstractDownloadStrategy/Pourable.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -176,13 +176,13 @@ <h3 class="signature first" id="stage-instance_method">
176176
<pre class="lines">
177177

178178

179-
38
180-
39
181-
40
182-
41</pre>
179+
34
180+
35
181+
36
182+
37</pre>
183183
</td>
184184
<td>
185-
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 38</span>
185+
<pre class="code"><span class="info file"># File 'download_strategy.rb', line 34</span>
186186

187187
<span class='kw'>def</span> <span class='id identifier rubyid_stage'>stage</span>
188188
<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>

0 commit comments

Comments
 (0)