summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Mesterhazy <etm2131@columbia.edu>2021-07-15 14:15:15 -0400
committerEvan Mesterhazy <etm2131@columbia.edu>2021-07-15 14:15:15 -0400
commit7209aeba7fd7188ecb3727ac19416978ad99499d (patch)
tree04b184cc921f0b8b2741943e7317b8f9a572296f
parent124a367fff514875eca9e1b876b7476d31272984 (diff)
downloadssh2-rs-7209aeba7fd7188ecb3727ac19416978ad99499d.zip
Revert "Add documentation on where to find async compatibile versions of ssh2-rs"
This reverts commit 0d316d2f734a4ee03523f6001f5a1a4bb7535bc9. As of this commit, https://crates.io/crates/async-ssh2/0.1.2-beta is listed as deprecated on crates.io. I believe that the other alternative mentioned in the reverted commit, async-ssh2-lite, has at least two serious correctness issues and should not be recommended: 1. https://github.com/bk-rs/async-ssh2-lite/issues/9 2. https://github.com/bk-rs/async-ssh2-lite/issues/10 async-ssh2-lite is also lacking documentation and has no unit or integration tests to give confidence in its implementation. In my opinion, until such issues are resolved ssh2 should refrain from recommending either of these crates to avoid misleading users into believing that these implementations are tested and ready for production.
-rw-r--r--src/lib.rs4
1 files changed, 0 insertions, 4 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 45f8e6b..42b3aea 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -7,10 +7,6 @@
//! Note that libssh2 only supports SSH *clients*, not SSH *servers*.
//! Additionally it only supports protocol v2, not protocol v1.
//!
-//! In case you are searching for an async versions of this library,
-//! you can look at https://github.com/spebern/async-ssh2 or https://github.com/bk-rs/async-ssh2-lite,
-//! which are both adding async compatibility on top of ssh2-rs implementation.
-//!
//! # Examples
//!
//! ## Inspecting ssh-agent