edgewall/trac

View on GitHub
doc/api/trac_versioncontrol_api.rst

Summary

Maintainability
Test Coverage
:mod:`trac.versioncontrol.api` -- Trac Version Control APIs
===========================================================

.. module :: trac.versioncontrol.api

This module implements an abstraction layer over different kind of
version control systems and the mechanism to access several
heterogeneous repositories under a single "virtual" hierarchy.

This abstraction was derived from the original model built around the
Subversion system (versioned tree, changesets). It gradually became
more general, now aiming at supporting distributed version control
systems (DVCS).


Interfaces
----------

.. autoclass :: IRepositoryConnector
   :members:

   See also :extensionpoints:`trac.versioncontrol.api.IRepositoryConnector`

.. autoclass :: IRepositoryProvider
   :members:

   See also :extensionpoints:`trac.versioncontrol.api.IRepositoryProvider`

.. autoclass :: IRepositoryChangeListener
   :members:

   See also :extensionpoints:`trac.versioncontrol.api.IRepositoryChangeListener`


Components
----------

.. autoclass :: RepositoryManager
   :members:

.. autoclass :: DbRepositoryProvider
   :members:


Exceptions
----------

.. autoexception :: InvalidConnector
   :members:

.. autoexception :: InvalidRepository
   :members:

Subclasses of `ResourceNotFound`.

.. autoexception :: NoSuchChangeset
   :members:

.. autoexception :: NoSuchNode
   :members:


Abstract classes
----------------

.. autoclass :: Repository
   :members:

.. autoclass :: Node
   :members:

.. autoclass :: Changeset
   :members:

.. autoclass :: EmptyChangeset
   :members:


Helper Functions
----------------

.. autofunction :: is_default