diff options
| author | W. Trevor King <wking@drexel.edu> | 2010-02-07 17:53:53 -0500 |
|---|---|---|
| committer | W. Trevor King <wking@drexel.edu> | 2010-02-07 17:53:53 -0500 |
| commit | 977eff5af10b50ba6e6edb6abc4f40804c418b12 (patch) | |
| tree | 77bd3dea340130bb1b446d5f7cc8d72000b5fba3 /libbe/storage/vcs/__init__.py | |
| parent | 8ccb71280c24480eb661fc668c31ff06bc7a3148 (diff) | |
| download | bugseverywhere-977eff5af10b50ba6e6edb6abc4f40804c418b12.tar.gz | |
Fixed docstrings so only Sphinx errors are "autosummary" and "missing attribute"
Diffstat (limited to 'libbe/storage/vcs/__init__.py')
| -rw-r--r-- | libbe/storage/vcs/__init__.py | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/libbe/storage/vcs/__init__.py b/libbe/storage/vcs/__init__.py index 777c723..552d43e 100644 --- a/libbe/storage/vcs/__init__.py +++ b/libbe/storage/vcs/__init__.py @@ -14,6 +14,23 @@ # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +"""Define the Version Controlled System (VCS)-based +:class:`~libbe.storage.base.Storage` and +:class:`~libbe.storage.base.VersionedStorage` implementations. + +There is a base class (:class:`~libbe.storage.vcs.VCS`) translating +Storage language to VCS language, and a number of `VCS` implementations: + +* :class:`~libbe.storage.vcs.arch.Arch` +* :class:`~libbe.storage.vcs.bzr.Bzr` +* :class:`~libbe.storage.vcs.darcs.Darcs` +* :class:`~libbe.storage.vcs.git.Git` +* :class:`~libbe.storage.vcs.hg.Hg` + +The base `VCS` class also serves as a filesystem Storage backend (not +versioning) in the event that a user has no VCS installed. +""" + import base set_preferred_vcs = base.set_preferred_vcs |