1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

Clarify git instructions in project guide. Fixes #11796

The git model uses `upstream master` to refer to the branch on
the remote repository, and `upstream/master` to refer to the
local cache of the upstream branch.

I did not explain the difference in the docs (that seemed a bit
excessive), but I did clarify the instructions so that it refers
to the correct concept in each place.

Signed-off-by: Katrina Owen <katrina.owen@gmail.com>
This commit is contained in:
Katrina Owen 2015-03-26 19:21:16 -07:00
parent d2df901be3
commit 54c9ae187f
2 changed files with 15 additions and 19 deletions

View file

@ -164,17 +164,16 @@ To sync your repository:
$ git remote add upstream https://github.com/docker/docker.git
5. Fetch all the changes from the `upstream/master` branch.
5. Fetch all the changes from the `upstream master` branch.
$ git fetch upstream
$ git fetch upstream master
remote: Counting objects: 141, done.
remote: Compressing objects: 100% (29/29), done.
remote: Total 141 (delta 52), reused 46 (delta 46), pack-reused 66
Receiving objects: 100% (141/141), 112.43 KiB | 0 bytes/s, done.
Resolving deltas: 100% (79/79), done.
From github.com:docker/docker
9ffdf1e..01d09e4 docs -> upstream/docs
05ba127..ac2521b master -> upstream/master
* branch master -> FETCH_HEAD
This command says get all the changes from the `master` branch belonging to
the `upstream` remote.
@ -197,9 +196,9 @@ To sync your repository:
nothing to commit, working directory clean
Your local repository now has any changes from the `upstream` remote. You
need to push the changes to your own remote fork which is `origin/master`.
need to push the changes to your own remote fork which is `origin master`.
9. Push the rebased master to `origin/master`.
9. Push the rebased master to `origin master`.
$ git push origin
Username for 'https://github.com': moxiegirl
@ -219,7 +218,7 @@ To sync your repository:
$ git checkout -b 11038-fix-rhel-link
Switched to a new branch '11038-fix-rhel-link'
Your branch should be up-to-date with the upstream/master. Why? Because you
Your branch should be up-to-date with the `upstream/master`. Why? Because you
branched off a freshly synced master. Let's check this anyway in the next
step.

View file

@ -120,10 +120,6 @@ Follow this workflow as you work:
* [new branch] 11038-fix-rhel-link -> 11038-fix-rhel-link
Branch 11038-fix-rhel-link set up to track remote branch 11038-fix-rhel-link from origin.
The first time you push a change, you must specify the branch. Later, you can just do this:
git push origin
## Review your branch on GitHub
After you push a new branch, you should verify it on GitHub:
@ -155,19 +151,20 @@ You should pull and rebase frequently as you work.
$ git branch 11038-fix-rhel-link
3. Fetch all the changes from the `upstream/master` branch.
3. Fetch all the changes from the `upstream master` branch.
$ git fetch upstream/master
$ git fetch upstream master
This command says get all the changes from the `master` branch belonging to
the `upstream` remote.
4. Rebase your local master with Docker's `upstream/master` branch.
4. Rebase your master with the local copy of Docker's `master` branch.
$ git rebase -i upstream/master
This command starts an interactive rebase to merge code from Docker's
`upstream/master` branch into your local branch. If you aren't familiar or
This command starts an interactive rebase to rewrite all the commits from
Docker's `upstream/master` onto your local branch, and then re-apply each of
your commits on top of the upstream changes. If you aren't familiar or
comfortable with rebase, you can <a
href="http://nathanleclaire.com/blog/2014/09/14/dont-be-scared-of-git-
rebase" target="_blank">learn more about rebasing</a> on the web.
@ -190,7 +187,7 @@ You should pull and rebase frequently as you work.
After closing the file, `git` opens your editor again to edit the commit
message.
7. Edit and save your commit message.
7. Edit the commit message to reflect the entire change.
Make sure you include your signature.