Skip to content
Snippets Groups Projects
semver_status.md 1.31 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Semver tracking
    
    This is a helpful file that we use for checking which crates will have
    breaking or nonbreaking API changes in the next release of Arti.
    
    For each crate, please write "BREAKING" if there is an API change that counts
    as breaking in semver, and "MODIFIED" if there is a backward-compatible API
    change.
    
    You can change from MODIFIED to BREAKING, but never from BREAKING to
    MODIFIED.
    
    You don't need to list details; this isn't the changelog.
    
    Don't document other changes in this file.
    
    We can delete older sections here after we bump the releases.
    
    
    
    arti-client, arti-config, tor-circmgr, tor-dirmgr:
    
    
      Drop conversion from FooConfig to FooConfigBuilder for many Foo.
      Further change in this area is expected.
    
      Drop impl Deserialize for ArtiConfig.
    
    
    arti-client:
    
      Replace ArtiClientBuilder's methods for individual elements of TorClientConfigBuilder
      with an accessor `.tor()` to get `&mut TorClientConfigBuilder`.
    
    
    Ian Jackson's avatar
    Ian Jackson committed
    arti:
    
      Provide library crate with unstable API.
    
    
    tor-llcrypto:
    
      new-api: Added RsaIdentity::from_hex().
    
    
    arti-client:
    
      api-break (experimental only): changed circmgr() and dirmgr() to return
      &Arc, not Arc.
    
    
    Nick Mathewson's avatar
    Nick Mathewson committed
    tor-dirmgr:
    
      new-api: DirMgrConfig object now has accessors.
    
    tor-netdoc:
    
      new-api (experimental only): Can modify the set of relays in an unverified
      consensus.