colin/hickory-dns
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

note minimum Rust version in docs

Browse Source
This commit is contained in:
Benjamin Fry 2019-10-21 23:14:54 -07:00
parent 94555c23c4
commit 11d1fdf2a9
9 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -166,7 +166,10 @@ presume that the trust-dns repos have already been synced to the local system:
## Prerequisites
- openssl development libraries (optional in client and resolver, min version 1.0.2)
### Minimum Rust Version
- The current minimum rustc version for this project is `1.39`
- OpenSSL development libraries (optional in client and resolver, min version 1.0.2)
### Mac OS X: using homebrew

4
crates/client/README.md
View File

@ -54,6 +54,10 @@ if let &RData::A(ref ip) = answers[0].rdata() {
}
```
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does it's best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

4
crates/https/README.md
View File

@ -4,6 +4,10 @@ Trust-DNS Rustls is a library which implements the DNS over HTTPS protocol and c
This library allows for HTTPS connections to be established to remote DNS servers. It can replace the standard `ClientConnection` in the Trust-DNS library. This uses the rustls and h2 libraries for HTTPS communications.
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does it's best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

4
crates/native-tls/README.md
View File

@ -4,6 +4,10 @@ Trust-DNS Native-TLS is a library which implements the DNS over TLS protocol and
This library allows for TLS connections to be established to remote DNS servers. It can replace the standard `ClientConnection` in the Trust-DNS library. This allows the host default TLS library to be used for handling TLS communications.
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does it's best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

4
crates/openssl/README.md
View File

@ -4,6 +4,10 @@ Trust-DNS OpenSSL is a library which implements the DNS over TLS protocol and cl
This library allows for TLS connections to be established to remote DNS servers. It can replace the standard `ClientConnection` in the Trust-DNS library. This uses OpenSSL library for all TLS communications.
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does it's best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

4
crates/proto/README.md
View File

@ -4,6 +4,10 @@ Trust-DNS Proto is the foundational DNS protocol library and implementation for
*WARNING* The Proto crate is designed as an internal layer in the Trust-DNS ecosystem, it will change potentially in breaking ways, and should not generally be used directly. Please see the Resolver, Client or Server for more stable interfaces.
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does it's best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

4
crates/resolver/README.md
View File

@ -69,6 +69,10 @@ let mut resolver = Resolver::new(ResolverConfig::cloudflare_tls(), ResolverOpts:
/// see example above...
```
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does its best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

4
crates/rustls/README.md
View File

@ -4,6 +4,10 @@ Trust-DNS Rustls is a library which implements the DNS over TLS protocol and cli
This library allows for TLS connections to be established to remote DNS servers. It can replace the standard `ClientConnection` in the Trust-DNS library. This uses the rustls TLS library for all TLS communications.
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does it's best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.

4
crates/server/README.md
View File

@ -22,6 +22,10 @@ This library contains basic implementations for DNS zone hosting. It is capable
- Full hint based resolving
- Maybe NSEC3 and/or NSEC5 support
## Minimum Rust Version
The current minimum rustc version for this project is `1.39`
## Versioning
Trust-DNS does it's best job to follow semver. Trust-DNS will be promoted to 1.0 upon stabilization of the publicly exposed APIs. This does not mean that Trust-DNS will necessarily break on upgrades between 0.x updates. Whenever possible, old APIs will be deprecated with notes on what replaced those deprecations. Trust-DNS will make a best effort to never break software which depends on it due to API changes, though this can not be guaranteed. Deprecated interfaces will be maintained for at minimum one major release after that in which they were deprecated (where possible), with the exception of the upgrade to 1.0 where all deprecated interfaces will be planned to be removed.