Byron/gitoxide git-repository-v0.14.0

git-repository v0.14.0

on GitHub

New Features

• Add easy::Tree::traverse() platform

• Add easy::Commit object
  It allows to more conveniently access commit information.

• easy::Oid::ancestors() now supports sorting() and iteration by first commit only
  Especially the sorting is useful to avoid having to sort commits by
  hand after collecting them.

• Use GITOXIDE_OBJECT_CACHE_MEMORY to control how much object cache is used
  Note that this is mostly for debugging or quickly seeing if object
  caches help with certain operations.

  Ideally the implementation knows themselves and sets up caches
  accordingly, probably after trying it with these environment variables.

Changed (BREAKING)

• rename easy::Object methods returning Ref objects to have ref in their name
  That way, it's more clear that the Ref versions are low-level ones
  whereas the into_ ones are higher-level ones that are part of the
  easy suite.

• Rename OwnedObject to DetachedObject
  The latter more clearly indicates what the difference is to
  Object (which is attached and carries a lifetime)

• Remove easy::borrow::Error entirely; support for multiple objects per handle
  This massive simplification finally allows any amounts of objects to be
  created while adding support for reusing their data buffers thanks
  to a simple free-list stored with the handle.

• rename easy::Object to OwnedObject; remove Ref suffix from ObjectRef and TreeRef

• use git_odb::Find* traits in prelude, instead of git_pack::Find*
  These are higher-level and generally more desirable.
  The Find traits in git-pack are more useful internally when packs
  have to be handled directly, for example when generating packs.

• rename easy::State to easy::Handle
  As the first step to remove the 'Easy' abstraction.

• fully rely on OdbHandle in repository State

• Rename Repository::odb to Repository::objects
  This way it's more inline with Repository::refs.

• remove Repository::refresh_object_database()
  With the linked DB this is simply not possible anymore and we expect
  these updates to happen automatically in future for greater convenience.

  For now, in order to refresh a repository, one has to reopen it.

• Rename Handle to Cache
  Because this is exactly what it is effectively.
  Also add some basic instantiation for the new object store.

• remove borrowing Repo as possible failure cause
  The easy::Handle is now a full (but shared) clone of the original
  Rpeository with additional thread-local state, hence there is no more
  need for a way to access the original repository.

• remove Easy… abstraction in favor of Handle
  This great reduction of complexity allows for being multi-threading
  capabie by default with the option to turn that off at compile time.

  All to|into_easy…() methods are removed in favor of to_easy()
  along with the removal of all Easy types in favor of the single

• remove pack-cache from Find::try_find(…)
  With the new architecture this can be an implementation detail without
  forcing it to be Sync.

• move git_pack::data::Object to git_object::Data, massively alter git_odb::Find trait
  This will break a lot, but has to happen to prepare these traits for the
  next generation of object databases.

Commit Statistics

• 65 commits contributed to the release over the course of 51 calendar days.
• 55 days passed between releases.
• 18 commits where understood as conventional.
• 6 unique issues were worked on: #215, #266, #274, #279, #287, #293

Commit Details