changeset 339:7d0cb1938ef9

Merge README cleanups.
author Augie Fackler <durin42@gmail.com>
date Sat, 12 Jun 2010 21:24:52 -0500
parents 203095c5cb25 (current diff) 9d9a55b0a8af (diff)
children 3d432479814c
files README.md
diffstat 1 files changed, 56 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/README.md
+++ b/README.md
@@ -15,46 +15,82 @@
 
 This plugin is implemented entirely in Python - there are no Git binary dependencies, you do not need to have Git installed on your system.  The only dependencies are Mercurial and Dulwich.  The plugin is known to work on Hg versions 1.1 through 1.3 and requires at least Dulwich 0.3.2.
 
-Commands
-=========
+Usage
+=====
 
-You can clone a Git repository from Hg by running `hg clone [url]`.  For example, if you were to run `hg clone git://github.com/schacon/munger.git` it would clone the repository down into the directory 'munger.git', then convert it to an Hg repository for you.
+You can clone a Git repository from Hg by running `hg clone [url]`.  For
+example, if you were to run
+
+    $ hg clone git://github.com/schacon/hg-git.git
+
+hg-git would clone the repository down into the directory 'munger.git', then
+convert it to an Hg repository for you.
 
-        hg clone git://github.com/schacon/hg-git.git
+If you want to clone a github repository for later pushing (or any other repository you access via ssh), you need to convert the ssh url to a format with an explicit protocol prefix. For example, the git url with push
+access
+
+    git@github.com:schacon/hg-git.git
+
+would read
 
-If you want to clone a github repository for later pushing (or any other repository you access via ssh), you need to convert the ssh url to a format with explicit protocol prefix (mind the switch from colon to slash after the host!):
+    git+ssh://git@github.com/schacon/hg-git.git
+
+(Mind the switch from colon to slash after the host!)
 
-        git clone git@github.com:schacon/hg-git.git
-        hg clone git+ssh://git@github.com/schacon/hg-git.git
+Your clone command would thus look like this:
+
+    $ hg clone git+ssh://git@github.com/schacon/hg-git.git
 
 If you are starting from an existing Hg repository, you have to setup a Git repository somewhere that you have push access to, add it as default path or default-push path in your .hg/hgrc and then run `hg push` from within your project.  For example:
 
-        cd hg-git # (an Hg repository)
-        (edit .hg/hgrc and add the target git url in the paths section)
-        hg push
+    $ cd hg-git # (an Hg repository)
+    $ # edit .hg/hgrc and add the target git url in the paths section
+    $ hg push
 
 This will convert all your Hg data into Git objects and push them up to the Git server.
 
 Now that you have an Hg repository that can push/pull to/from a Git repository, you can fetch updates with `hg pull`.
 
-        $ hg pull
+    $ hg pull
 
 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).
 
-        $ mkdir git-repo; cd git-repo; git init; cd ..
-        $ cd hg-repo
-        $ hg bookmarks hg
-        $ hg push git+ssh://localhost:git-repo
+    $ mkdir git-repo; cd git-repo; git init; cd ..
+    $ cd hg-repo
+    $ hg bookmarks hg
+    $ hg push git+ssh://localhost: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 create a branch named hg in the Git repository. To get the changes in master use the following command (only necessary in the first run, later just use git merge or rebase).
 
-        $ cd git-repo
-        $ git checkout -b master hg
+    $ cd git-repo
+    $ git checkout -b master hg
 
 To import new changesets into the Git repository just rerun the hg push command and then use git merge or git rebase in your Git repository.
 
+Commands
+========
+
+gclear
+------
+
+TODO
+
+gimport
+-------
+
+TODO
+
+gexport
+-------
+
+TODO
+
+git-cleanup
+-----------
+
+TODO
 
 Hg Bookmarks Integration
 ========================
@@ -68,9 +104,9 @@
 
 Clone this repository somewhere and make the 'extensions' section in your `~/.hgrc` file look something like this:
 
-        [extensions]
-        hgext.bookmarks =
-        hggit = [path-to]/hg-git/hggit
+    [extensions]
+    hgext.bookmarks =
+    hggit = [path-to]/hg-git/hggit
 
 That will enable the Hg-Git extension for you.  The bookmarks section is not compulsory, but it makes some things a bit nicer for you.