Commit e299c2b4 authored by Ian Jackson's avatar Ian Jackson 💬
Browse files

Merge branch 'keymgr' into 'main' 

tor-keymgr: Adjust stability guarantees for release

Closes #934

See merge request tpo/core/arti!1346
parents 4f446d59 954e20bb

crates/tor-keymgr/Cargo.toml

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ categories = ["cryptography"] 
repository = "https://gitlab.torproject.org/tpo/core/arti.git/"



[features]

default = ["keymgr"]

default = []



# Enable experimental APIs that are not yet officially supported.

#

crates/tor-keymgr/README.md

+19 −4
Original line number Diff line number Diff line
@@ -8,10 +8,12 @@ This crate is part of 
[Arti](https://gitlab.torproject.org/tpo/core/arti/), a project to

implement [Tor](https://www.torproject.org/) in Rust.



### **UNSTABLE**

### **Likely to change**



The APIs exposed by this crate are experimental and not covered by semver

guarantees.

The APIs exposed by this crate (even without the `keymgr` feature)

are new and are likely to change rapidly.

We'll therefore often be making semver-breaking changes

(and will update the crate version accordingly).



## Key stores
@@ -57,5 +59,18 @@ stable 


### Additive features



* `keymgr` (default) -- build with full key manager support. Disabling this

(None yet.)



### Experimental and unstable features



 Note that the APIs enabled by these features are NOT covered by semantic

 versioning[^1] guarantees: we might break them or remove them between patch

 versions.



* `keymgr` -- build with full key manager support. Disabling this

  feature causes `tor-keymgr` to export a no-op, placeholder implementation.



[^1]: Remember, semantic versioning is what makes various `cargo`

features work reliably. To be explicit: if you want `cargo update`

to _only_ make safe changes, then you cannot enable these

features.