Georg Brandl avatar Georg Brandl committed b069d95 Merge

Merged in eoranged/hgbb/docs (pull request #5)

Comments (0)

Files changed (2)

+Bitbucket support for Mercurial
+===============================
+
+Features
+--------
+
+* short URLs for bitbucket projects: bb:user/repo
+* looking for incoming changes in all forks bitbucket knows about
+* listing all followers of the repo
+* getting link to the repository or the any file
+* creating repo on bitbucket
+
+Mercurial configuration
+-----------------------
+
+You might write something like this to your ~/.hgrc or another hgrc file.
+
+    [bb]
+    username = your bitbucket username
+    password = your bitbucket http password for http (otherwise you'll be asked)
+    default_method = the default checkout method to use (ssh or http)
+
+You can read more about hgrc [in mercurial documentation](http://www.selenic.com/mercurial/hgrc.5.html "Configuration files for Mercurial")
+
+Short URLs
+----------
+
+With hgbb you can access bitbucket repositories via nicer uris:
+
+`bb://repo` points to your own "repo" repository, checkout via default method
+
+`bb://username/repo` points to the "repo" repository by username, checkout via default method
+
+`bb+http://repo` points to your own "repo" repository, checkout via http
+
+`bb+http://username/repo` points to the "repo" repository by username, checkout via http
+
+`bb+ssh://repo` points to your own "repo" repository, checkout via ssh
+
+`bb+ssh://username/repo` points to the "repo" repository by username, checkout via ssh
     return urllib2.urlopen(req).read()
 
 def bb_create(ui, reponame, **opts):
+    """Create repository on bitbucket"""
     data = {
         'name': reponame,
         'description': opts.get('description'),
             follower['last_name']))))
 
 def bb_link(ui, repo, filename=None, **opts):
-    '''display a bitbucket link to the repository, or the the specific file if given'''
+    '''display a bitbucket link to the repository, or the specific file if given'''
     # XXX: might not work on windows, because it uses \ to separate paths
     lineno = opts.get('lineno')
     reponame = get_bbreponame(ui, repo, opts)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.