Skip to content
This repository has been archived by the owner on Oct 13, 2021. It is now read-only.

Commit

Permalink
Tweak some docs in the vcs module.
Browse files Browse the repository at this point in the history
This is an effective no-op to test deploys of the newly merged es branch.
  • Loading branch information
erikrose committed Aug 3, 2015
1 parent a7d9ddd commit 94f3b24
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions dxr/vcs.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
"""Let DXR understand the concept of version control systems. The main entry
points are `tree_to_repos`, which produces a mapping of roots to VCS objects
for each version control root discovered under the provided tree, and
`path_to_vcs`, which returns a VCS object for the version control system that
tracks the given path. Currently supported VCS are Mercurial, Git, and
Perforce.
"""DXR's concept of version control systems
The main entry points are `tree_to_repos`, which produces a mapping of roots
to VCS objects for each version control root discovered under the provided
tree, and `path_to_vcs`, which returns a VCS object for the version control
system that tracks the given path. Currently supported VCSs are Mercurial,
Git, and Perforce.
Currently supported upstream views:
- git (github)
- mercurial (hgweb)
Todos:
- add gitweb support for git
- add cvs, svn, bzr support
- produce in-DXR blame information using VCSs
- check if the mercurial paths are specific to Mozilla's customization or not.
TODO:
- Add gitweb support for git.
- Add cvs, svn, bzr support.
- Produce in-DXR blame information using VCSs.
- Check if the mercurial paths are specific to Mozilla's customization or not.
"""
import marshal
import os
Expand Down Expand Up @@ -276,8 +278,10 @@ def display_rev(self, path):
info = self.have[path]
return '#' + info['haveRev']


every_vcs = [Mercurial, Git, Perforce]


def tree_to_repos(tree):
"""Given a TreeConfig, return a mapping {root: Vcs object} where root is a
directory under tree.source_folder where root is a directory under
Expand Down Expand Up @@ -358,4 +362,3 @@ def vcs_for_path(self, path):
self._path_cache[path] = vcs
break
return self._path_cache.get(path)

0 comments on commit 94f3b24

Please sign in to comment.