Add a clean command that works like git clean -dxn with -f to delete option.

[code/myrepos.git] / doc / index.mdwn

diff --git a/doc/index.mdwn b/doc/index.mdwn
index 01a3e784ca85637a1e64651e303476cfdeda6c2a..b5a25113fd55188ac21f101633f228f411424615 100644 (file)
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -16,7 +16,7 @@ That sets up a `~/.mrconfig` file listing your repositories.
 Now you can run `mr update` in your home directory, and it'll update
 every one of your repositories that you've registered with myrepos.
 
 Now you can run `mr update` in your home directory, and it'll update
 every one of your repositories that you've registered with myrepos.
 

-Want to update repositories in parallel? `mr update -j5` will run 5
+Want to update repositories in parallel? `mr -j5 update` will run 5

 concurrent jobs!
 
 If you run `mr update` inside a repository, it'll only act on that
 concurrent jobs!
 
 If you run `mr update` inside a repository, it'll only act on that


@@ -40,8 +40,7 @@ run for any repository. It's like a `Makefile` for repositories.
        checkout = git@github.com:joeyh/foo.git
        update = git pull --rebase
 
        checkout = git@github.com:joeyh/foo.git
        update = git pull --rebase
 

-You can make up your own commands too, and add them to a single repository,
-or even globally so `mr` can use them in all repositories.
+You can make up your own commands too:

 
        [bar]
        # This repository has an upstream, which I've forked; 
 
        [bar]
        # This repository has an upstream, which I've forked; 


@@ -56,9 +55,11 @@ or even globally so `mr` can use them in all repositories.
                git merge upstream/master
                git push origin master
 
                git merge upstream/master
                git push origin master
 

+You can even define commands globally, so `mr` can use them in all repositories.
+

        [DEFAULT]
        [DEFAULT]

-       # Teach mr how to `mr reup` to update with rebasing.
-       git_reup = git pull --rebase
+       # Teach mr how to `mr gc` in git repos.
+       git_gc = git gc "$@"

 
 This only scratches the surface of the ways you can use myrepos to automate
 and mange your repositories!
 
 This only scratches the surface of the ways you can use myrepos to automate
 and mange your repositories!