diff options
| author | Junio C Hamano <junkio@cox.net> | 2005-11-05 22:26:52 -0800 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2005-11-06 00:26:21 -0800 |
| commit | 4607166d0735d13e0ee4ffe8df0c2fc899957852 (patch) | |
| tree | 48f8aa4a29bebaa82c792302a9c7e59bb6265869 /Documentation/pull-fetch-param.txt | |
| parent | b748421aaae3fbb8e0e6466ba532bcec1c71e660 (diff) | |
| download | git-4607166d0735d13e0ee4ffe8df0c2fc899957852.tar.gz git-4607166d0735d13e0ee4ffe8df0c2fc899957852.tar.xz | |
Documentation: pull/clone ref mapping clarification.
Josef Weidendorfer points out that git-clone documentation does not
mention the initial copying of remote branch heads into corresponding
local branches. Also clarify the purpose of the ref mappings description
in the "remotes" file and recommended workflow.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/pull-fetch-param.txt')
| -rw-r--r-- | Documentation/pull-fetch-param.txt | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index 57e9ddf0d..5c2888e16 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -82,14 +82,19 @@ must know this is the expected usage pattern for a branch. [NOTE] You never do your own development on branches that appear on the right hand side of a <refspec> colon on `Pull:` lines; -they are to be updated by `git-fetch`. The corollary is that -a local branch should be introduced and named on a <refspec> -right-hand-side if you intend to do development derived from -that branch. -This leads to the common `Pull: master:origin` mapping of a -remote `master` branch to a local `origin` branch, which -is then merged to a local development branch, again typically -named `master`. +they are to be updated by `git-fetch`. If you intend to do +development derived from a remote branch `B`, have a `Pull:` +line to track it (i.e. `Pull: B:remote-B`), and have a separate +branch `my-B` to do your development on top of it. The latter +is created by `git branch my-B remote-B` (or its equivalent `git +checkout -b my-B remote-B`). Run `git fetch` to keep track of +the progress of the remote side, and when you see something new +on the remote branch, merge it into your development branch with +`git pull . remote-B`, while you are on `my-B` branch. +The common `Pull: master:origin` mapping of a remote `master` +branch to a local `origin` branch, which is then merged to a +ocal development branch, again typically named `master`, is made +when you run `git clone` for you to follow this pattern. + [NOTE] There is a difference between listing multiple <refspec> |