Remove some cascaded functions, change defaults, docs

Going through the rustdocs, the all the overloaded functions were rather
confusing. Since most of these methods are only used in a few special
places, this patch removes most overloads, and keeps:

* RepoBuilder<Root>::commit
* RepoBuilder<Root>::add_target

Next, rather than using `create_*` and `with_*_builder`, it switches to
`stage_*` and `stage_*_with_builder` to make it more obvious that we haven't
written the metadata yet.

Next, it changes the root metadata to default to consistent_snapshots,
since that avoids many race conditions, and is a safer default.

Finally, it cleans up the docs.
6 files changed
tree: 39f1af7360f24f2457d04f14571cbdc8a374fbc1
  1. .github/
  2. interop-tests/
  3. tuf/
  4. .gitattributes
  5. .gitignore
  6. Cargo.toml
  7. LICENSE-APACHE
  8. LICENSE-MIT
  9. MAINTAINERS
  10. README.md
  11. rustfmt.toml
README.md

rust-tuf

A Rust implementation of The Update Framework (TUF).

Full documentation is hosted at docs.rs.

Warning: Beta Software

This is under active development and may not suitable for production use. Further, the API is unstable and you should be prepared to refactor on even patch releases.

Contributing

Please make all pull requests to the develop branch.

Bugs

This project has a full disclosure policy on security related errors. Please treat these errors like all other bugs and file a public issue. Errors communicated via other channels will be immediately made public.

Legal

License

This work is dual licensed under the MIT and Apache-2.0 licenses. See LICENSE-MIT and LICENSE-APACHE for details.