Code

docs: simplify example 1
authorBryan Larsen <bryan@larsen.st>
Wed, 21 Jul 2010 16:58:05 +0000 (12:58 -0400)
committerAvery Pennarun <apenwarr@gmail.com>
Wed, 21 Jul 2010 17:41:38 +0000 (13:41 -0400)
The documentation was written prior to Wayne Walter's 2-parameter add.
Using 2-parameter add in example 1 makes the example much simpler.

git-subtree.txt

index 4f715c640bc6b8f25df9c8306292eb354d16c481..dbcba31346793d897dcecb274e578cefb8cbd92c 100644 (file)
@@ -236,18 +236,14 @@ EXAMPLE 1
 Let's assume that you have a local repository that you would like
 to add an external vendor library to. In this case we will add the
 git-subtree repository as a subdirectory of your already existing
-git-extensions repository in ~/git-extensions/.
+git-extensions repository in ~/git-extensions/:
 
-First we need to fetch the remote objects
-       $ cd ~/git-extensions
-       $ git fetch git://github.com/apenwarr/git-subtree.git master
+       $ git subtree add --prefix=git-subtree --squash \
+               git://github.com/apenwarr/git-subtree.git master
 
 'master' needs to be a valid remote ref and can be a different branch
 name
 
-Now we add the vendor library with
-       $ git subtree add --prefix=git-subtree --squash FETCH_HEAD
-
 You can omit the --squash flag, but doing so will increase the number
 of commits that are incldued in your local repository.