Merge branch 'master' of github.com:GoogleCloudPlatform/java-repo-tools into lint

tswast · tswast · commit f89ed2e1effe · 2016-04-12T11:38:19.000-07:00
diff --git a/README.md b/README.md
@@ -41,6 +41,19 @@ git checkout master
 # Making a new branch ia optional, but recommended to send a pull request to
 # start using java-repo-tools.
 git checkout -b use-java-repo-tools
+```
+
+So that we can pull future updates from the `java-repo-tools` repository, we
+merge histories. This way we won't get unnecessary conflicts when pulling changes
+in.
+
+```
+git merge -s ours --no-commit java-repo-tools/master
+```
+
+Finally, read the `java-repo-tools` into a subtree.
+
+```
 git read-tree --prefix=java-repo-tools/ -u java-repo-tools
 ```
 
@@ -82,17 +95,13 @@ now-redundant plugin information.
 If you haven't done this before, run
 
 ```
-git remote add java-repo-tools
-git@github.com:GoogleCloudPlatform/java-repo-tools.git
-git fetch java-repo-tools master
-# Optional, but it makes pushing changes upstream easier.
-git checkout -b java-repo-tools java-repo-tools/master
+git remote add java-repo-tools git@github.com:GoogleCloudPlatform/java-repo-tools.git
 ```
 
 To detect if you have changes in the directory, run
 
 ```
-git fetch java-repo-tools
+git fetch java-repo-tools master
 git diff-tree -p HEAD:java-repo-tools/ java-repo-tools/master
 ```
 
@@ -111,33 +120,17 @@ directory.)
 To update the `java-repo-tools` directory, if you haven't done this before, run
 
 ```
-git remote add java-repo-tools
-git@github.com:GoogleCloudPlatform/java-repo-tools.git
-git fetch java-repo-tools master
-git checkout -b java-repo-tools java-repo-tools/master
-```
-
-To pull the changes when in this branch run
-
-```
-git pull java-repo-tools master
-```
-
-To pull the changes back from upstream:
-
-```
-git checkout java-repo-tools
-git pull java-repo-tools master
+git remote add java-repo-tools git@github.com:GoogleCloudPlatform/java-repo-tools.git
 ```
 
-Pull them into the main code.
+To pull the latest changes from this `java-repo-tools` repository, run:
 
 ```
 git checkout master
 # Making a new branch is optional, but recommended to send a pull request for
 # update.
 git checkout -b update-java-repo-tools
-git merge --squash -Xsubtree=java-repo-tools/ --no-commit java-repo-tools
+git pull -s subtree java-repo-tools master
 ```
 
 Then you can make any needed changes to make the rest of the repository
@@ -171,6 +164,10 @@ git push java-repo-tools java-repo-tools:name-for-remote-branch
 Then, you can send a pull request to the `java-repo-tools` repository.
 
 
+## References
+
+- [GitHub's subtree merge reference](https://help.github.com/articles/about-git-subtree-merges/)
+
 ## Contributing changes
 
 -  See [CONTRIBUTING.md](CONTRIBUTING.md)
