Skip to content

Commit 43c6858

Browse files
delanodelano
committed
Updated docs for 2.1 release
1 parent 437a5ad commit 43c6858

File tree

80 files changed

+201
-186
lines changed

Some content is hidden

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

80 files changed

+201
-186
lines changed

‎ssh/v2/api/classes/Net.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ <h1 class='name'>
3131
</h1>
3232
<ol class='paths'>
3333
<li>
34-
<a href="../files/lib/net/ssh/authentication/constants_rb.html">lib/net/ssh/authentication/constants.rb</a>
34+
<a href="../files/lib/net/ssh/authentication/agent_rb.html">lib/net/ssh/authentication/agent.rb</a>
3535
</li>
3636
<li class='other'>
37-
<a href="../files/lib/net/ssh/authentication/agent_rb.html">lib/net/ssh/authentication/agent.rb</a>
37+
<a href="../files/lib/net/ssh/authentication/constants_rb.html">lib/net/ssh/authentication/constants.rb</a>
3838
</li>
3939
<li class='other'>
4040
<a href="../files/lib/net/ssh/authentication/key_manager_rb.html">lib/net/ssh/authentication/key_manager.rb</a>
@@ -85,10 +85,10 @@ <h1 class='name'>
8585
<a href="../files/lib/net/ssh/errors_rb.html">lib/net/ssh/errors.rb</a>
8686
</li>
8787
<li class='other'>
88-
<a href="../files/lib/net/ssh/known_hosts_rb.html">lib/net/ssh/known_hosts.rb</a>
88+
<a href="../files/lib/net/ssh/key_factory_rb.html">lib/net/ssh/key_factory.rb</a>
8989
</li>
9090
<li class='other'>
91-
<a href="../files/lib/net/ssh/key_factory_rb.html">lib/net/ssh/key_factory.rb</a>
91+
<a href="../files/lib/net/ssh/known_hosts_rb.html">lib/net/ssh/known_hosts.rb</a>
9292
</li>
9393
<li class='other'>
9494
<a href="../files/lib/net/ssh/loggable_rb.html">lib/net/ssh/loggable.rb</a>
@@ -130,19 +130,19 @@ <h1 class='name'>
130130
<a href="../files/lib/net/ssh/test/kex_rb.html">lib/net/ssh/test/kex.rb</a>
131131
</li>
132132
<li class='other'>
133-
<a href="../files/lib/net/ssh/test/packet_rb.html">lib/net/ssh/test/packet.rb</a>
133+
<a href="../files/lib/net/ssh/test/local_packet_rb.html">lib/net/ssh/test/local_packet.rb</a>
134134
</li>
135135
<li class='other'>
136-
<a href="../files/lib/net/ssh/test/local_packet_rb.html">lib/net/ssh/test/local_packet.rb</a>
136+
<a href="../files/lib/net/ssh/test/packet_rb.html">lib/net/ssh/test/packet.rb</a>
137137
</li>
138138
<li class='other'>
139139
<a href="../files/lib/net/ssh/test/remote_packet_rb.html">lib/net/ssh/test/remote_packet.rb</a>
140140
</li>
141141
<li class='other'>
142-
<a href="../files/lib/net/ssh/test/script_rb.html">lib/net/ssh/test/script.rb</a>
142+
<a href="../files/lib/net/ssh/test/socket_rb.html">lib/net/ssh/test/socket.rb</a>
143143
</li>
144144
<li class='other'>
145-
<a href="../files/lib/net/ssh/test/socket_rb.html">lib/net/ssh/test/socket.rb</a>
145+
<a href="../files/lib/net/ssh/test/script_rb.html">lib/net/ssh/test/script.rb</a>
146146
</li>
147147
<li class='other'>
148148
<a href="../files/lib/net/ssh/test_rb.html">lib/net/ssh/test.rb</a>

‎ssh/v2/api/classes/Net/SSH.html‎

Lines changed: 17 additions & 11 deletions
Large diffs are not rendered by default.

‎ssh/v2/api/classes/Net/SSH/Authentication.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ <h1 class='name'>
3131
</h1>
3232
<ol class='paths'>
3333
<li>
34-
<a href="../../../files/lib/net/ssh/authentication/constants_rb.html">lib/net/ssh/authentication/constants.rb</a>
34+
<a href="../../../files/lib/net/ssh/authentication/agent_rb.html">lib/net/ssh/authentication/agent.rb</a>
3535
</li>
3636
<li class='other'>
37-
<a href="../../../files/lib/net/ssh/authentication/agent_rb.html">lib/net/ssh/authentication/agent.rb</a>
37+
<a href="../../../files/lib/net/ssh/authentication/constants_rb.html">lib/net/ssh/authentication/constants.rb</a>
3838
</li>
3939
<li class='other'>
4040
<a href="../../../files/lib/net/ssh/authentication/key_manager_rb.html">lib/net/ssh/authentication/key_manager.rb</a>

‎ssh/v2/api/classes/Net/SSH/Authentication/KeyManager.html‎

Lines changed: 9 additions & 5 deletions
Large diffs are not rendered by default.

‎ssh/v2/api/classes/Net/SSH/Config.html‎

Lines changed: 7 additions & 4 deletions
Large diffs are not rendered by default.

‎ssh/v2/api/classes/Net/SSH/Connection.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ <h1 class='name'>
3131
</h1>
3232
<ol class='paths'>
3333
<li>
34-
<a href="../../../files/lib/net/ssh/connection/constants_rb.html">lib/net/ssh/connection/constants.rb</a>
34+
<a href="../../../files/lib/net/ssh/connection/channel_rb.html">lib/net/ssh/connection/channel.rb</a>
3535
</li>
3636
<li class='other'>
37-
<a href="../../../files/lib/net/ssh/connection/channel_rb.html">lib/net/ssh/connection/channel.rb</a>
37+
<a href="../../../files/lib/net/ssh/connection/constants_rb.html">lib/net/ssh/connection/constants.rb</a>
3838
</li>
3939
<li class='other'>
4040
<a href="../../../files/lib/net/ssh/connection/session_rb.html">lib/net/ssh/connection/session.rb</a>

‎ssh/v2/api/classes/Net/SSH/Loggable.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h2>Public instance methods</h2>
9393
<a class='source-toggle' href='#' onclick="toggleCode('M000103-source'); return false">
9494
[show source]
9595
</a>
96-
<pre id='M000103-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 24</span>&#x000A;24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>&#x000A;25: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span>&#x000A;26: <span class="ruby-keyword kw">end</span></pre>
96+
<pre id='M000103-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 24</span>&#x000A;24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>&#x000A;25: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug?</span>&#x000A;26: <span class="ruby-keyword kw">end</span></pre>
9797
</div>
9898
</div>
9999
<div class='method public-instance' id='method-M000106'>
@@ -112,7 +112,7 @@ <h2>Public instance methods</h2>
112112
<a class='source-toggle' href='#' onclick="toggleCode('M000106-source'); return false">
113113
[show source]
114114
</a>
115-
<pre id='M000106-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 42</span>&#x000A;42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>&#x000A;43: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">ERROR</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span>&#x000A;44: <span class="ruby-keyword kw">end</span></pre>
115+
<pre id='M000106-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 42</span>&#x000A;42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>&#x000A;43: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">ERROR</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">error?</span>&#x000A;44: <span class="ruby-keyword kw">end</span></pre>
116116
</div>
117117
</div>
118118
<div class='method public-instance' id='method-M000107'>
@@ -131,7 +131,7 @@ <h2>Public instance methods</h2>
131131
<a class='source-toggle' href='#' onclick="toggleCode('M000107-source'); return false">
132132
[show source]
133133
</a>
134-
<pre id='M000107-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 48</span>&#x000A;48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fatal</span>&#x000A;49: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span>&#x000A;50: <span class="ruby-keyword kw">end</span></pre>
134+
<pre id='M000107-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 48</span>&#x000A;48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fatal</span>&#x000A;49: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">fatal?</span>&#x000A;50: <span class="ruby-keyword kw">end</span></pre>
135135
</div>
136136
</div>
137137
<div class='method public-instance' id='method-M000104'>
@@ -150,7 +150,7 @@ <h2>Public instance methods</h2>
150150
<a class='source-toggle' href='#' onclick="toggleCode('M000104-source'); return false">
151151
[show source]
152152
</a>
153-
<pre id='M000104-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 30</span>&#x000A;30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">info</span>&#x000A;31: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">INFO</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span>&#x000A;32: <span class="ruby-keyword kw">end</span></pre>
153+
<pre id='M000104-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 30</span>&#x000A;30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">info</span>&#x000A;31: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">INFO</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info?</span>&#x000A;32: <span class="ruby-keyword kw">end</span></pre>
154154
</div>
155155
</div>
156156
<div class='method public-instance' id='method-M000105'>
@@ -169,7 +169,7 @@ <h2>Public instance methods</h2>
169169
<a class='source-toggle' href='#' onclick="toggleCode('M000105-source'); return false">
170170
[show source]
171171
</a>
172-
<pre id='M000105-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 36</span>&#x000A;36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lwarn</span>&#x000A;37: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span>&#x000A;38: <span class="ruby-keyword kw">end</span></pre>
172+
<pre id='M000105-source'> <span class="ruby-comment cmt"># File lib/net/ssh/loggable.rb, line 36</span>&#x000A;36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lwarn</span>&#x000A;37: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">facility</span>) { <span class="ruby-keyword kw">yield</span> } <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">warn?</span>&#x000A;38: <span class="ruby-keyword kw">end</span></pre>
173173
</div>
174174
</div>
175175
</div>

‎ssh/v2/api/classes/Net/SSH/Test.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,19 @@ <h1 class='name'>
4040
<a href="../../../files/lib/net/ssh/test/kex_rb.html">lib/net/ssh/test/kex.rb</a>
4141
</li>
4242
<li class='other'>
43-
<a href="../../../files/lib/net/ssh/test/packet_rb.html">lib/net/ssh/test/packet.rb</a>
43+
<a href="../../../files/lib/net/ssh/test/local_packet_rb.html">lib/net/ssh/test/local_packet.rb</a>
4444
</li>
4545
<li class='other'>
46-
<a href="../../../files/lib/net/ssh/test/local_packet_rb.html">lib/net/ssh/test/local_packet.rb</a>
46+
<a href="../../../files/lib/net/ssh/test/packet_rb.html">lib/net/ssh/test/packet.rb</a>
4747
</li>
4848
<li class='other'>
4949
<a href="../../../files/lib/net/ssh/test/remote_packet_rb.html">lib/net/ssh/test/remote_packet.rb</a>
5050
</li>
5151
<li class='other'>
52-
<a href="../../../files/lib/net/ssh/test/script_rb.html">lib/net/ssh/test/script.rb</a>
52+
<a href="../../../files/lib/net/ssh/test/socket_rb.html">lib/net/ssh/test/socket.rb</a>
5353
</li>
5454
<li class='other'>
55-
<a href="../../../files/lib/net/ssh/test/socket_rb.html">lib/net/ssh/test/socket.rb</a>
55+
<a href="../../../files/lib/net/ssh/test/script_rb.html">lib/net/ssh/test/script.rb</a>
5656
</li>
5757
<li class='other'>
5858
<a href="../../../files/lib/net/ssh/test_rb.html">lib/net/ssh/test.rb</a>

‎ssh/v2/api/classes/Net/SSH/Test/Channel.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ <h2>Public instance methods</h2>
242242
Returns the local (client-assigned) id for this channel, or a Proc object
243243
that will return the local-id later if the local id has not yet been set.
244244
(See <a
245-
href="Packet.html#M000158">Net::SSH::Test::Packet#instantiate!</a>.)
245+
href="Packet.html#M000161">Net::SSH::Test::Packet#instantiate!</a>.)
246246
</p>
247247
</div>
248248
<div class='source'>
@@ -263,7 +263,7 @@ <h2>Public instance methods</h2>
263263
Returns the remote (server-assigned) id for this channel, or a Proc object
264264
that will return the remote-id later if the remote id has not yet been set.
265265
(See <a
266-
href="Packet.html#M000158">Net::SSH::Test::Packet#instantiate!</a>.)
266+
href="Packet.html#M000161">Net::SSH::Test::Packet#instantiate!</a>.)
267267
</p>
268268
</div>
269269
<div class='source'>

0 commit comments

Comments
 (0)