changeset 530:1ec00e2805fb

docs: update to correctly reflect that local git repositories are supported
author David M. Carr <david@carrclan.us>
date Thu, 13 Sep 2012 20:57:37 -0400
parents 7edcbdd2ef2f
children 800625c63100
files DESIGN.txt README.md hggit/help/git.rst
diffstat 3 files changed, 12 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/DESIGN.txt
+++ b/DESIGN.txt
@@ -63,7 +63,3 @@
 And you should see output like this:
 .
 # Ran 1 tests, 0 skipped, 0 failed.
-
-Note that due to limitations of Dulwich at the moment, the tests need to
-start a git-daemon process. Right now, they use the default port, so will
-skip if they detect an already-running git-daemon.
--- a/README.md
+++ b/README.md
@@ -74,15 +74,15 @@
 That will pull down any commits that have been pushed to the server in
 the meantime and give you a new head that you can merge in.
 
-Hg-Git can also be used to convert a Mercurial repository to Git.  As
-Dulwich doesn't support local repositories yet, the easiest way is to
-setup up a local SSH server.  Then use the following commands to
-convert the repository (it assumes your running this in $HOME).
+Hg-Git can also be used to convert a Mercurial repository to Git.  You can use
+a local repository or a remote repository accessed via SSH, HTTP or HTTPS.  Use
+the following commands to convert the repository (it assumes your running this
+in $HOME).
 
     $ mkdir git-repo; cd git-repo; git init; cd ..
     $ cd hg-repo
     $ hg bookmarks hg
-    $ hg push git+ssh://localhost:git-repo
+    $ hg push ../git-repo
 
 The hg bookmark is necessary to prevent problems as otherwise hg-git
 pushes to the currently checked out branch confusing Git. This will
--- a/hggit/help/git.rst
+++ b/hggit/help/git.rst
@@ -14,12 +14,16 @@
   http://code.google.com/p/guava-libraries
   ssh://git@github.com:schacon/hg-git.git
   git://github.com/schacon/hg-git.git
+  ../hg-git (local file path)
 
-For protocols other than git://, it isn't clear whether these should be
-interpreted as Mercurial or Git URLs. Thus, to specify that a URL should
+For the HTTP, HTTPS, and SSH protocols, it isn't clear based solely on
+the URL whether the remote repository should be treated as a Mercurial
+repository or a Git repository.  Thus, to specify that a URL should
 use Git, prepend the URL with "git+". For example, an HTTPS URL would
 start with "git+https://". Also, note that Git doesn't require the
-specification of the protocol for SSH, but Mercurial does.
+specification of the protocol for SSH, but Mercurial does.  Hg-Git
+automatically detects whether file paths should be treated as Git repositories
+by their contents.
 
 If you are starting from an existing Hg repository, you have to set up a
 Git repository somewhere that you have push access to, add a path entry
@@ -72,9 +76,3 @@
 
 Revsets are accepted by several Mercurial commands for specifying revisions.
 See ``hg help revsets`` for details.
-
-Limitations
------------
-
-- Cloning/pushing/pulling local Git repositories is not supported (due to
-  lack of support in Dulwich)