libbe/storage/vcs/__init__.py

   1 # Copyright (C) 2009-2012 Chris Ball <cjb@laptop.org>
   2 #                         W. Trevor King <wking@tremily.us>
   3 #
   4 # This file is part of Bugs Everywhere.
   5 #
   6 # Bugs Everywhere is free software: you can redistribute it and/or modify it
   7 # under the terms of the GNU General Public License as published by the Free
   8 # Software Foundation, either version 2 of the License, or (at your option) any
   9 # later version.
  10 #
  11 # Bugs Everywhere is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14 # more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 """Define the Version Controlled System (VCS)-based
  20 :class:`~libbe.storage.base.Storage` and
  21 :class:`~libbe.storage.base.VersionedStorage` implementations.
  22
  23 There is a base class (:class:`~libbe.storage.vcs.VCS`) translating
  24 Storage language to VCS language, and a number of `VCS` implementations:
  25
  26 * :class:`~libbe.storage.vcs.arch.Arch`
  27 * :class:`~libbe.storage.vcs.bzr.Bzr`
  28 * :class:`~libbe.storage.vcs.darcs.Darcs`
  29 * :class:`~libbe.storage.vcs.git.Git`
  30 * :class:`~libbe.storage.vcs.hg.Hg`
  31
  32 The base `VCS` class also serves as a filesystem Storage backend (not
  33 versioning) in the event that a user has no VCS installed.
  34 """
  35
  36 import base
  37
  38 set_preferred_vcs = base.set_preferred_vcs
  39 vcs_by_name = base.vcs_by_name
  40 detect_vcs = base.detect_vcs
  41 installed_vcs = base.installed_vcs
  42
  43 __all__ = [set_preferred_vcs, vcs_by_name, detect_vcs, installed_vcs]